diff --git a/generated/google/apis/adexchangebuyer2_v2beta1.rb b/generated/google/apis/adexchangebuyer2_v2beta1.rb index ee532e8fa..c7b1af4d5 100644 --- a/generated/google/apis/adexchangebuyer2_v2beta1.rb +++ b/generated/google/apis/adexchangebuyer2_v2beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://developers.google.com/authorized-buyers/apis/reference/rest/ module Adexchangebuyer2V2beta1 VERSION = 'V2beta1' - REVISION = '20200402' + REVISION = '20200506' # Manage your Ad Exchange buyer account configuration AUTH_ADEXCHANGE_BUYER = 'https://www.googleapis.com/auth/adexchange.buyer' diff --git a/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb b/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb index d8a1eef18..995761b35 100644 --- a/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb +++ b/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb @@ -273,6 +273,12 @@ module Google # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :measurable_impressions + # A metric value, with an expected value and a variance; represents a count + # that may be either exact or estimated (i.e. when sampled). + # Corresponds to the JSON property `reachedQueries` + # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] + attr_accessor :reached_queries + # A response may include multiple rows, breaking down along various dimensions. # Encapsulates the values of all dimensions for a given row. # Corresponds to the JSON property `rowDimensions` @@ -296,6 +302,7 @@ module Google @billed_impressions = args[:billed_impressions] if args.key?(:billed_impressions) @impressions_won = args[:impressions_won] if args.key?(:impressions_won) @measurable_impressions = args[:measurable_impressions] if args.key?(:measurable_impressions) + @reached_queries = args[:reached_queries] if args.key?(:reached_queries) @row_dimensions = args[:row_dimensions] if args.key?(:row_dimensions) @viewable_impressions = args[:viewable_impressions] if args.key?(:viewable_impressions) end @@ -3456,7 +3463,8 @@ module Google # Note: this resource requires whitelisting for access. Please contact your # account manager for access to Marketplace resources. - # Represents a publisher profile in Marketplace. + # Represents a publisher profile + # (https://support.google.com/admanager/answer/6035806?hl=en) in Marketplace. # All fields are read only. All string fields are free-form text entered by the # publisher unless noted otherwise. class PublisherProfile @@ -3498,6 +3506,18 @@ module Google # @return [String] attr_accessor :google_plus_url + # Indicates if this profile is the parent profile of the seller. A parent + # profile represents all the inventory from the seller, as opposed to child + # profile that is created to brand a portion of inventory. One seller should + # have only one parent publisher profile, and can have multiple child + # profiles. Publisher profiles for the same seller will have same value of + # field google.ads.adexchange.buyer.v2beta1.PublisherProfile.seller. + # See https://support.google.com/admanager/answer/6035806?hl=en for details. + # Corresponds to the JSON property `isParent` + # @return [Boolean] + attr_accessor :is_parent + alias_method :is_parent?, :is_parent + # A Google public URL to the logo for this publisher profile. The logo is # stored as a PNG, JPG, or GIF image. # Corresponds to the JSON property `logoUrl` @@ -3560,6 +3580,7 @@ module Google @display_name = args[:display_name] if args.key?(:display_name) @domains = args[:domains] if args.key?(:domains) @google_plus_url = args[:google_plus_url] if args.key?(:google_plus_url) + @is_parent = args[:is_parent] if args.key?(:is_parent) @logo_url = args[:logo_url] if args.key?(:logo_url) @media_kit_url = args[:media_kit_url] if args.key?(:media_kit_url) @overview = args[:overview] if args.key?(:overview) diff --git a/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb b/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb index 14678206d..435738145 100644 --- a/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb +++ b/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb @@ -729,6 +729,8 @@ module Google property :measurable_impressions, as: 'measurableImpressions', class: Google::Apis::Adexchangebuyer2V2beta1::MetricValue, decorator: Google::Apis::Adexchangebuyer2V2beta1::MetricValue::Representation + property :reached_queries, as: 'reachedQueries', class: Google::Apis::Adexchangebuyer2V2beta1::MetricValue, decorator: Google::Apis::Adexchangebuyer2V2beta1::MetricValue::Representation + property :row_dimensions, as: 'rowDimensions', class: Google::Apis::Adexchangebuyer2V2beta1::RowDimensions, decorator: Google::Apis::Adexchangebuyer2V2beta1::RowDimensions::Representation property :viewable_impressions, as: 'viewableImpressions', class: Google::Apis::Adexchangebuyer2V2beta1::MetricValue, decorator: Google::Apis::Adexchangebuyer2V2beta1::MetricValue::Representation @@ -1585,6 +1587,7 @@ module Google property :display_name, as: 'displayName' collection :domains, as: 'domains' property :google_plus_url, as: 'googlePlusUrl' + property :is_parent, as: 'isParent' property :logo_url, as: 'logoUrl' property :media_kit_url, as: 'mediaKitUrl' property :overview, as: 'overview' diff --git a/generated/google/apis/androidenterprise_v1.rb b/generated/google/apis/androidenterprise_v1.rb index d73742c4e..fa82ed4d6 100644 --- a/generated/google/apis/androidenterprise_v1.rb +++ b/generated/google/apis/androidenterprise_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/android/work/play/emm-api module AndroidenterpriseV1 VERSION = 'V1' - REVISION = '20200315' + REVISION = '20200427' # Manage corporate Android devices AUTH_ANDROIDENTERPRISE = 'https://www.googleapis.com/auth/androidenterprise' diff --git a/generated/google/apis/androidenterprise_v1/classes.rb b/generated/google/apis/androidenterprise_v1/classes.rb index cc73ddc81..525630797 100644 --- a/generated/google/apis/androidenterprise_v1/classes.rb +++ b/generated/google/apis/androidenterprise_v1/classes.rb @@ -1971,7 +1971,8 @@ module Google # @return [String] attr_accessor :product_availability_policy - # The list of product policies. + # The list of product policies. The productAvailabilityPolicy needs to be set to + # WHITELIST or ALL for the product policies to be applied. # Corresponds to the JSON property `productPolicy` # @return [Array] attr_accessor :product_policy diff --git a/generated/google/apis/androidpublisher_v1.rb b/generated/google/apis/androidpublisher_v1.rb index 1441eb522..d3aa740dc 100644 --- a/generated/google/apis/androidpublisher_v1.rb +++ b/generated/google/apis/androidpublisher_v1.rb @@ -25,10 +25,7 @@ module Google # @see https://developers.google.com/android-publisher module AndroidpublisherV1 VERSION = 'V1' - REVISION = '20181009' - - # View and manage your Google Play Developer account - AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher' + REVISION = '20200428' end end end diff --git a/generated/google/apis/androidpublisher_v1/classes.rb b/generated/google/apis/androidpublisher_v1/classes.rb index b70543e32..cc62d1349 100644 --- a/generated/google/apis/androidpublisher_v1/classes.rb +++ b/generated/google/apis/androidpublisher_v1/classes.rb @@ -21,47 +21,6 @@ require 'google/apis/errors' module Google module Apis module AndroidpublisherV1 - - # A SubscriptionPurchase resource indicates the status of a user's subscription - # purchase. - class SubscriptionPurchase - include Google::Apis::Core::Hashable - - # Whether the subscription will automatically be renewed when it reaches its - # current expiry time. - # Corresponds to the JSON property `autoRenewing` - # @return [Boolean] - attr_accessor :auto_renewing - alias_method :auto_renewing?, :auto_renewing - - # Time at which the subscription was granted, in milliseconds since the Epoch. - # Corresponds to the JSON property `initiationTimestampMsec` - # @return [Fixnum] - attr_accessor :initiation_timestamp_msec - - # This kind represents a subscriptionPurchase object in the androidpublisher - # service. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # Time at which the subscription will expire, in milliseconds since the Epoch. - # Corresponds to the JSON property `validUntilTimestampMsec` - # @return [Fixnum] - attr_accessor :valid_until_timestamp_msec - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @auto_renewing = args[:auto_renewing] if args.key?(:auto_renewing) - @initiation_timestamp_msec = args[:initiation_timestamp_msec] if args.key?(:initiation_timestamp_msec) - @kind = args[:kind] if args.key?(:kind) - @valid_until_timestamp_msec = args[:valid_until_timestamp_msec] if args.key?(:valid_until_timestamp_msec) - end - end end end end diff --git a/generated/google/apis/androidpublisher_v1/representations.rb b/generated/google/apis/androidpublisher_v1/representations.rb index 5e1b33e9a..cc62d1349 100644 --- a/generated/google/apis/androidpublisher_v1/representations.rb +++ b/generated/google/apis/androidpublisher_v1/representations.rb @@ -21,22 +21,6 @@ require 'google/apis/errors' module Google module Apis module AndroidpublisherV1 - - class SubscriptionPurchase - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SubscriptionPurchase - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :auto_renewing, as: 'autoRenewing' - property :initiation_timestamp_msec, :numeric_string => true, as: 'initiationTimestampMsec' - property :kind, as: 'kind' - property :valid_until_timestamp_msec, :numeric_string => true, as: 'validUntilTimestampMsec' - end - end end end end diff --git a/generated/google/apis/androidpublisher_v1/service.rb b/generated/google/apis/androidpublisher_v1/service.rb index 2b230928f..54173c450 100644 --- a/generated/google/apis/androidpublisher_v1/service.rb +++ b/generated/google/apis/androidpublisher_v1/service.rb @@ -47,89 +47,9 @@ module Google attr_accessor :user_ip def initialize - super('https://www.googleapis.com/', 'androidpublisher/v1/applications/') + super('https://www.googleapis.com/', '') @batch_path = 'batch/androidpublisher/v1' end - - # Cancels a user's subscription purchase. The subscription remains valid until - # its expiration time. - # @param [String] package_name - # The package name of the application for which this subscription was purchased ( - # for example, 'com.some.thing'). - # @param [String] subscription_id - # The purchased subscription ID (for example, 'monthly001'). - # @param [String] token - # The token provided to the user's device when the subscription was purchased. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def cancel_purchase(package_name, subscription_id, token, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{packageName}/subscriptions/{subscriptionId}/purchases/{token}/cancel', options) - command.params['packageName'] = package_name unless package_name.nil? - command.params['subscriptionId'] = subscription_id unless subscription_id.nil? - command.params['token'] = token unless token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Checks whether a user's subscription purchase is valid and returns its expiry - # time. - # @param [String] package_name - # The package name of the application for which this subscription was purchased ( - # for example, 'com.some.thing'). - # @param [String] subscription_id - # The purchased subscription ID (for example, 'monthly001'). - # @param [String] token - # The token provided to the user's device when the subscription was purchased. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV1::SubscriptionPurchase] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV1::SubscriptionPurchase] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_purchase(package_name, subscription_id, token, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{packageName}/subscriptions/{subscriptionId}/purchases/{token}', options) - command.response_representation = Google::Apis::AndroidpublisherV1::SubscriptionPurchase::Representation - command.response_class = Google::Apis::AndroidpublisherV1::SubscriptionPurchase - command.params['packageName'] = package_name unless package_name.nil? - command.params['subscriptionId'] = subscription_id unless subscription_id.nil? - command.params['token'] = token unless token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end protected diff --git a/generated/google/apis/androidpublisher_v1_1.rb b/generated/google/apis/androidpublisher_v1_1.rb index 3f2f6e622..4d31b9c4e 100644 --- a/generated/google/apis/androidpublisher_v1_1.rb +++ b/generated/google/apis/androidpublisher_v1_1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/android-publisher module AndroidpublisherV1_1 VERSION = 'V1_1' - REVISION = '20190618' + REVISION = '20200428' # View and manage your Google Play Developer account AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher' diff --git a/generated/google/apis/androidpublisher_v1_1/classes.rb b/generated/google/apis/androidpublisher_v1_1/classes.rb index 00af5891c..62cc2553e 100644 --- a/generated/google/apis/androidpublisher_v1_1/classes.rb +++ b/generated/google/apis/androidpublisher_v1_1/classes.rb @@ -89,47 +89,6 @@ module Google @purchase_type = args[:purchase_type] if args.key?(:purchase_type) end end - - # A SubscriptionPurchase resource indicates the status of a user's subscription - # purchase. - class SubscriptionPurchase - include Google::Apis::Core::Hashable - - # Whether the subscription will automatically be renewed when it reaches its - # current expiry time. - # Corresponds to the JSON property `autoRenewing` - # @return [Boolean] - attr_accessor :auto_renewing - alias_method :auto_renewing?, :auto_renewing - - # Time at which the subscription was granted, in milliseconds since the Epoch. - # Corresponds to the JSON property `initiationTimestampMsec` - # @return [Fixnum] - attr_accessor :initiation_timestamp_msec - - # This kind represents a subscriptionPurchase object in the androidpublisher - # service. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # Time at which the subscription will expire, in milliseconds since the Epoch. - # Corresponds to the JSON property `validUntilTimestampMsec` - # @return [Fixnum] - attr_accessor :valid_until_timestamp_msec - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @auto_renewing = args[:auto_renewing] if args.key?(:auto_renewing) - @initiation_timestamp_msec = args[:initiation_timestamp_msec] if args.key?(:initiation_timestamp_msec) - @kind = args[:kind] if args.key?(:kind) - @valid_until_timestamp_msec = args[:valid_until_timestamp_msec] if args.key?(:valid_until_timestamp_msec) - end - end end end end diff --git a/generated/google/apis/androidpublisher_v1_1/representations.rb b/generated/google/apis/androidpublisher_v1_1/representations.rb index 94466d816..b6fa4dc02 100644 --- a/generated/google/apis/androidpublisher_v1_1/representations.rb +++ b/generated/google/apis/androidpublisher_v1_1/representations.rb @@ -28,12 +28,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class SubscriptionPurchase - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class InappPurchase # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -46,16 +40,6 @@ module Google property :purchase_type, as: 'purchaseType' end end - - class SubscriptionPurchase - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :auto_renewing, as: 'autoRenewing' - property :initiation_timestamp_msec, :numeric_string => true, as: 'initiationTimestampMsec' - property :kind, as: 'kind' - property :valid_until_timestamp_msec, :numeric_string => true, as: 'validUntilTimestampMsec' - end - end end end end diff --git a/generated/google/apis/androidpublisher_v1_1/service.rb b/generated/google/apis/androidpublisher_v1_1/service.rb index 67474aa9c..c6e343006 100644 --- a/generated/google/apis/androidpublisher_v1_1/service.rb +++ b/generated/google/apis/androidpublisher_v1_1/service.rb @@ -90,86 +90,6 @@ module Google command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - - # Cancels a user's subscription purchase. The subscription remains valid until - # its expiration time. - # @param [String] package_name - # The package name of the application for which this subscription was purchased ( - # for example, 'com.some.thing'). - # @param [String] subscription_id - # The purchased subscription ID (for example, 'monthly001'). - # @param [String] token - # The token provided to the user's device when the subscription was purchased. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def cancel_purchase(package_name, subscription_id, token, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{packageName}/subscriptions/{subscriptionId}/purchases/{token}/cancel', options) - command.params['packageName'] = package_name unless package_name.nil? - command.params['subscriptionId'] = subscription_id unless subscription_id.nil? - command.params['token'] = token unless token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Checks whether a user's subscription purchase is valid and returns its expiry - # time. - # @param [String] package_name - # The package name of the application for which this subscription was purchased ( - # for example, 'com.some.thing'). - # @param [String] subscription_id - # The purchased subscription ID (for example, 'monthly001'). - # @param [String] token - # The token provided to the user's device when the subscription was purchased. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV1_1::SubscriptionPurchase] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV1_1::SubscriptionPurchase] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_purchase(package_name, subscription_id, token, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{packageName}/subscriptions/{subscriptionId}/purchases/{token}', options) - command.response_representation = Google::Apis::AndroidpublisherV1_1::SubscriptionPurchase::Representation - command.response_class = Google::Apis::AndroidpublisherV1_1::SubscriptionPurchase - command.params['packageName'] = package_name unless package_name.nil? - command.params['subscriptionId'] = subscription_id unless subscription_id.nil? - command.params['token'] = token unless token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end protected diff --git a/generated/google/apis/androidpublisher_v2.rb b/generated/google/apis/androidpublisher_v2.rb index d859d44e6..efcef6355 100644 --- a/generated/google/apis/androidpublisher_v2.rb +++ b/generated/google/apis/androidpublisher_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/android-publisher module AndroidpublisherV2 VERSION = 'V2' - REVISION = '20200331' + REVISION = '20200428' # View and manage your Google Play Developer account AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher' diff --git a/generated/google/apis/androidpublisher_v2/classes.rb b/generated/google/apis/androidpublisher_v2/classes.rb index e2a86b46e..5652ddb21 100644 --- a/generated/google/apis/androidpublisher_v2/classes.rb +++ b/generated/google/apis/androidpublisher_v2/classes.rb @@ -22,965 +22,6 @@ module Google module Apis module AndroidpublisherV2 - # - class Apk - include Google::Apis::Core::Hashable - - # Represents the binary payload of an APK. - # Corresponds to the JSON property `binary` - # @return [Google::Apis::AndroidpublisherV2::ApkBinary] - attr_accessor :binary - - # The version code of the APK, as specified in the APK's manifest file. - # Corresponds to the JSON property `versionCode` - # @return [Fixnum] - attr_accessor :version_code - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @binary = args[:binary] if args.key?(:binary) - @version_code = args[:version_code] if args.key?(:version_code) - end - end - - # Represents the binary payload of an APK. - class ApkBinary - include Google::Apis::Core::Hashable - - # A sha1 hash of the APK payload, encoded as a hex string and matching the - # output of the sha1sum command. - # Corresponds to the JSON property `sha1` - # @return [String] - attr_accessor :sha1 - - # A sha256 hash of the APK payload, encoded as a hex string and matching the - # output of the sha256sum command. - # Corresponds to the JSON property `sha256` - # @return [String] - attr_accessor :sha256 - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @sha1 = args[:sha1] if args.key?(:sha1) - @sha256 = args[:sha256] if args.key?(:sha256) - end - end - - # - class ApkListing - include Google::Apis::Core::Hashable - - # The language code, in BCP 47 format (eg "en-US"). - # Corresponds to the JSON property `language` - # @return [String] - attr_accessor :language - - # Describe what's new in your APK. - # Corresponds to the JSON property `recentChanges` - # @return [String] - attr_accessor :recent_changes - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @language = args[:language] if args.key?(:language) - @recent_changes = args[:recent_changes] if args.key?(:recent_changes) - end - end - - # - class ListApkListingsResponse - include Google::Apis::Core::Hashable - - # Identifies what kind of resource this is. Value: the fixed string " - # androidpublisher#apkListingsListResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # - # Corresponds to the JSON property `listings` - # @return [Array] - attr_accessor :listings - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @listings = args[:listings] if args.key?(:listings) - end - end - - # - class ApksAddExternallyHostedRequest - include Google::Apis::Core::Hashable - - # Defines an APK available for this application that is hosted externally and - # not uploaded to Google Play. This function is only available to enterprises - # who are using Google Play for Work, and whos application is restricted to the - # enterprise private channel - # Corresponds to the JSON property `externallyHostedApk` - # @return [Google::Apis::AndroidpublisherV2::ExternallyHostedApk] - attr_accessor :externally_hosted_apk - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @externally_hosted_apk = args[:externally_hosted_apk] if args.key?(:externally_hosted_apk) - end - end - - # - class ApksAddExternallyHostedResponse - include Google::Apis::Core::Hashable - - # Defines an APK available for this application that is hosted externally and - # not uploaded to Google Play. This function is only available to enterprises - # who are using Google Play for Work, and whos application is restricted to the - # enterprise private channel - # Corresponds to the JSON property `externallyHostedApk` - # @return [Google::Apis::AndroidpublisherV2::ExternallyHostedApk] - attr_accessor :externally_hosted_apk - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @externally_hosted_apk = args[:externally_hosted_apk] if args.key?(:externally_hosted_apk) - end - end - - # - class ListApksResponse - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `apks` - # @return [Array] - attr_accessor :apks - - # Identifies what kind of resource this is. Value: the fixed string " - # androidpublisher#apksListResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @apks = args[:apks] if args.key?(:apks) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class AppDetails - include Google::Apis::Core::Hashable - - # The user-visible support email for this app. - # Corresponds to the JSON property `contactEmail` - # @return [String] - attr_accessor :contact_email - - # The user-visible support telephone number for this app. - # Corresponds to the JSON property `contactPhone` - # @return [String] - attr_accessor :contact_phone - - # The user-visible website for this app. - # Corresponds to the JSON property `contactWebsite` - # @return [String] - attr_accessor :contact_website - - # Default language code, in BCP 47 format (eg "en-US"). - # Corresponds to the JSON property `defaultLanguage` - # @return [String] - attr_accessor :default_language - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @contact_email = args[:contact_email] if args.key?(:contact_email) - @contact_phone = args[:contact_phone] if args.key?(:contact_phone) - @contact_website = args[:contact_website] if args.key?(:contact_website) - @default_language = args[:default_language] if args.key?(:default_language) - end - end - - # Represents an edit of an app. An edit allows clients to make multiple changes - # before committing them in one operation. - class AppEdit - include Google::Apis::Core::Hashable - - # The time at which the edit will expire and will be no longer valid for use in - # any subsequent API calls (encoded as seconds since the Epoch). - # Corresponds to the JSON property `expiryTimeSeconds` - # @return [String] - attr_accessor :expiry_time_seconds - - # The ID of the edit that can be used in subsequent API calls. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @expiry_time_seconds = args[:expiry_time_seconds] if args.key?(:expiry_time_seconds) - @id = args[:id] if args.key?(:id) - end - end - - # - class Bundle - include Google::Apis::Core::Hashable - - # A sha1 hash of the upload payload, encoded as a hex string and matching the - # output of the sha1sum command. - # Corresponds to the JSON property `sha1` - # @return [String] - attr_accessor :sha1 - - # A sha256 hash of the upload payload, encoded as a hex string and matching the - # output of the sha256sum command. - # Corresponds to the JSON property `sha256` - # @return [String] - attr_accessor :sha256 - - # The version code of the Android App Bundle. As specified in the Android App - # Bundle's base module APK manifest file. - # Corresponds to the JSON property `versionCode` - # @return [Fixnum] - attr_accessor :version_code - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @sha1 = args[:sha1] if args.key?(:sha1) - @sha256 = args[:sha256] if args.key?(:sha256) - @version_code = args[:version_code] if args.key?(:version_code) - end - end - - # - class BundlesListResponse - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `bundles` - # @return [Array] - attr_accessor :bundles - - # Identifies what kind of resource this is. Value: the fixed string " - # androidpublisher#bundlesListResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @bundles = args[:bundles] if args.key?(:bundles) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class Comment - include Google::Apis::Core::Hashable - - # A comment from a developer. - # Corresponds to the JSON property `developerComment` - # @return [Google::Apis::AndroidpublisherV2::DeveloperComment] - attr_accessor :developer_comment - - # A comment from a user. - # Corresponds to the JSON property `userComment` - # @return [Google::Apis::AndroidpublisherV2::UserComment] - attr_accessor :user_comment - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @developer_comment = args[:developer_comment] if args.key?(:developer_comment) - @user_comment = args[:user_comment] if args.key?(:user_comment) - end - end - - # Represents a deobfuscation file. - class DeobfuscationFile - include Google::Apis::Core::Hashable - - # The type of the deobfuscation file. - # Corresponds to the JSON property `symbolType` - # @return [String] - attr_accessor :symbol_type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @symbol_type = args[:symbol_type] if args.key?(:symbol_type) - end - end - - # - class DeobfuscationFilesUploadResponse - include Google::Apis::Core::Hashable - - # Represents a deobfuscation file. - # Corresponds to the JSON property `deobfuscationFile` - # @return [Google::Apis::AndroidpublisherV2::DeobfuscationFile] - attr_accessor :deobfuscation_file - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @deobfuscation_file = args[:deobfuscation_file] if args.key?(:deobfuscation_file) - end - end - - # - class DeveloperComment - include Google::Apis::Core::Hashable - - # The last time at which this comment was updated. - # Corresponds to the JSON property `lastModified` - # @return [Google::Apis::AndroidpublisherV2::Timestamp] - attr_accessor :last_modified - - # The content of the comment, i.e. reply body. - # Corresponds to the JSON property `text` - # @return [String] - attr_accessor :text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @last_modified = args[:last_modified] if args.key?(:last_modified) - @text = args[:text] if args.key?(:text) - end - end - - # - class DeviceMetadata - include Google::Apis::Core::Hashable - - # Device CPU make e.g. "Qualcomm" - # Corresponds to the JSON property `cpuMake` - # @return [String] - attr_accessor :cpu_make - - # Device CPU model e.g. "MSM8974" - # Corresponds to the JSON property `cpuModel` - # @return [String] - attr_accessor :cpu_model - - # Device class (e.g. tablet) - # Corresponds to the JSON property `deviceClass` - # @return [String] - attr_accessor :device_class - - # OpenGL version - # Corresponds to the JSON property `glEsVersion` - # @return [Fixnum] - attr_accessor :gl_es_version - - # Device manufacturer (e.g. Motorola) - # Corresponds to the JSON property `manufacturer` - # @return [String] - attr_accessor :manufacturer - - # Comma separated list of native platforms (e.g. "arm", "arm7") - # Corresponds to the JSON property `nativePlatform` - # @return [String] - attr_accessor :native_platform - - # Device model name (e.g. Droid) - # Corresponds to the JSON property `productName` - # @return [String] - attr_accessor :product_name - - # Device RAM in Megabytes e.g. "2048" - # Corresponds to the JSON property `ramMb` - # @return [Fixnum] - attr_accessor :ram_mb - - # Screen density in DPI - # Corresponds to the JSON property `screenDensityDpi` - # @return [Fixnum] - attr_accessor :screen_density_dpi - - # Screen height in pixels - # Corresponds to the JSON property `screenHeightPx` - # @return [Fixnum] - attr_accessor :screen_height_px - - # Screen width in pixels - # Corresponds to the JSON property `screenWidthPx` - # @return [Fixnum] - attr_accessor :screen_width_px - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @cpu_make = args[:cpu_make] if args.key?(:cpu_make) - @cpu_model = args[:cpu_model] if args.key?(:cpu_model) - @device_class = args[:device_class] if args.key?(:device_class) - @gl_es_version = args[:gl_es_version] if args.key?(:gl_es_version) - @manufacturer = args[:manufacturer] if args.key?(:manufacturer) - @native_platform = args[:native_platform] if args.key?(:native_platform) - @product_name = args[:product_name] if args.key?(:product_name) - @ram_mb = args[:ram_mb] if args.key?(:ram_mb) - @screen_density_dpi = args[:screen_density_dpi] if args.key?(:screen_density_dpi) - @screen_height_px = args[:screen_height_px] if args.key?(:screen_height_px) - @screen_width_px = args[:screen_width_px] if args.key?(:screen_width_px) - end - end - - # - class ExpansionFile - include Google::Apis::Core::Hashable - - # If set this field indicates that this APK has an Expansion File uploaded to it: - # this APK does not reference another APK's Expansion File. The field's value - # is the size of the uploaded Expansion File in bytes. - # Corresponds to the JSON property `fileSize` - # @return [Fixnum] - attr_accessor :file_size - - # If set this APK's Expansion File references another APK's Expansion File. The - # file_size field will not be set. - # Corresponds to the JSON property `referencesVersion` - # @return [Fixnum] - attr_accessor :references_version - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @file_size = args[:file_size] if args.key?(:file_size) - @references_version = args[:references_version] if args.key?(:references_version) - end - end - - # - class UploadExpansionFilesResponse - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `expansionFile` - # @return [Google::Apis::AndroidpublisherV2::ExpansionFile] - attr_accessor :expansion_file - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @expansion_file = args[:expansion_file] if args.key?(:expansion_file) - end - end - - # Defines an APK available for this application that is hosted externally and - # not uploaded to Google Play. This function is only available to enterprises - # who are using Google Play for Work, and whos application is restricted to the - # enterprise private channel - class ExternallyHostedApk - include Google::Apis::Core::Hashable - - # The application label. - # Corresponds to the JSON property `applicationLabel` - # @return [String] - attr_accessor :application_label - - # A certificate (or array of certificates if a certificate-chain is used) used - # to signed this APK, represented as a base64 encoded byte array. - # Corresponds to the JSON property `certificateBase64s` - # @return [Array] - attr_accessor :certificate_base64s - - # The URL at which the APK is hosted. This must be an https URL. - # Corresponds to the JSON property `externallyHostedUrl` - # @return [String] - attr_accessor :externally_hosted_url - - # The SHA1 checksum of this APK, represented as a base64 encoded byte array. - # Corresponds to the JSON property `fileSha1Base64` - # @return [String] - attr_accessor :file_sha1_base64 - - # The SHA256 checksum of this APK, represented as a base64 encoded byte array. - # Corresponds to the JSON property `fileSha256Base64` - # @return [String] - attr_accessor :file_sha256_base64 - - # The file size in bytes of this APK. - # Corresponds to the JSON property `fileSize` - # @return [Fixnum] - attr_accessor :file_size - - # The icon image from the APK, as a base64 encoded byte array. - # Corresponds to the JSON property `iconBase64` - # @return [String] - attr_accessor :icon_base64 - - # The maximum SDK supported by this APK (optional). - # Corresponds to the JSON property `maximumSdk` - # @return [Fixnum] - attr_accessor :maximum_sdk - - # The minimum SDK targeted by this APK. - # Corresponds to the JSON property `minimumSdk` - # @return [Fixnum] - attr_accessor :minimum_sdk - - # The native code environments supported by this APK (optional). - # Corresponds to the JSON property `nativeCodes` - # @return [Array] - attr_accessor :native_codes - - # The package name. - # Corresponds to the JSON property `packageName` - # @return [String] - attr_accessor :package_name - - # The features required by this APK (optional). - # Corresponds to the JSON property `usesFeatures` - # @return [Array] - attr_accessor :uses_features - - # The permissions requested by this APK. - # Corresponds to the JSON property `usesPermissions` - # @return [Array] - attr_accessor :uses_permissions - - # The version code of this APK. - # Corresponds to the JSON property `versionCode` - # @return [Fixnum] - attr_accessor :version_code - - # The version name of this APK. - # Corresponds to the JSON property `versionName` - # @return [String] - attr_accessor :version_name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @application_label = args[:application_label] if args.key?(:application_label) - @certificate_base64s = args[:certificate_base64s] if args.key?(:certificate_base64s) - @externally_hosted_url = args[:externally_hosted_url] if args.key?(:externally_hosted_url) - @file_sha1_base64 = args[:file_sha1_base64] if args.key?(:file_sha1_base64) - @file_sha256_base64 = args[:file_sha256_base64] if args.key?(:file_sha256_base64) - @file_size = args[:file_size] if args.key?(:file_size) - @icon_base64 = args[:icon_base64] if args.key?(:icon_base64) - @maximum_sdk = args[:maximum_sdk] if args.key?(:maximum_sdk) - @minimum_sdk = args[:minimum_sdk] if args.key?(:minimum_sdk) - @native_codes = args[:native_codes] if args.key?(:native_codes) - @package_name = args[:package_name] if args.key?(:package_name) - @uses_features = args[:uses_features] if args.key?(:uses_features) - @uses_permissions = args[:uses_permissions] if args.key?(:uses_permissions) - @version_code = args[:version_code] if args.key?(:version_code) - @version_name = args[:version_name] if args.key?(:version_name) - end - end - - # A permission used by this APK. - class ExternallyHostedApkUsesPermission - include Google::Apis::Core::Hashable - - # Optionally, the maximum SDK version for which the permission is required. - # Corresponds to the JSON property `maxSdkVersion` - # @return [Fixnum] - attr_accessor :max_sdk_version - - # The name of the permission requested. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @max_sdk_version = args[:max_sdk_version] if args.key?(:max_sdk_version) - @name = args[:name] if args.key?(:name) - end - end - - # - class Image - include Google::Apis::Core::Hashable - - # A unique id representing this image. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # A sha1 hash of the image that was uploaded. - # Corresponds to the JSON property `sha1` - # @return [String] - attr_accessor :sha1 - - # A sha256 hash of the image that was uploaded. - # Corresponds to the JSON property `sha256` - # @return [String] - attr_accessor :sha256 - - # A URL that will serve a preview of the image. - # Corresponds to the JSON property `url` - # @return [String] - attr_accessor :url - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @id = args[:id] if args.key?(:id) - @sha1 = args[:sha1] if args.key?(:sha1) - @sha256 = args[:sha256] if args.key?(:sha256) - @url = args[:url] if args.key?(:url) - end - end - - # - class DeleteAllImagesResponse - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `deleted` - # @return [Array] - attr_accessor :deleted - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @deleted = args[:deleted] if args.key?(:deleted) - end - end - - # - class ListImagesResponse - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `images` - # @return [Array] - attr_accessor :images - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @images = args[:images] if args.key?(:images) - end - end - - # - class UploadImagesResponse - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `image` - # @return [Google::Apis::AndroidpublisherV2::Image] - attr_accessor :image - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @image = args[:image] if args.key?(:image) - end - end - - # - class InAppProduct - include Google::Apis::Core::Hashable - - # The default language of the localized data, as defined by BCP 47. e.g. "en-US", - # "en-GB". - # Corresponds to the JSON property `defaultLanguage` - # @return [String] - attr_accessor :default_language - - # Default price cannot be zero. In-app products can never be free. Default price - # is always in the developer's Checkout merchant currency. - # Corresponds to the JSON property `defaultPrice` - # @return [Google::Apis::AndroidpublisherV2::Price] - attr_accessor :default_price - - # Grace period of the subscription, specified in ISO 8601 format. It will allow - # developers to give their subscribers a grace period when the payment for the - # new recurrence period is declined. Acceptable values = "P3D" (three days), " - # P7D" (seven days), "P14D" (fourteen days), and "P30D" (thirty days) - # Corresponds to the JSON property `gracePeriod` - # @return [String] - attr_accessor :grace_period - - # List of localized title and description data. - # Corresponds to the JSON property `listings` - # @return [Hash] - attr_accessor :listings - - # The package name of the parent app. - # Corresponds to the JSON property `packageName` - # @return [String] - attr_accessor :package_name - - # Prices per buyer region. None of these prices should be zero. In-app products - # can never be free. - # Corresponds to the JSON property `prices` - # @return [Hash] - attr_accessor :prices - - # Purchase type enum value. Unmodifiable after creation. - # Corresponds to the JSON property `purchaseType` - # @return [String] - attr_accessor :purchase_type - - # The stock-keeping-unit (SKU) of the product, unique within an app. - # Corresponds to the JSON property `sku` - # @return [String] - attr_accessor :sku - - # - # Corresponds to the JSON property `status` - # @return [String] - attr_accessor :status - - # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" - # (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and " - # P1Y" (one year). - # Corresponds to the JSON property `subscriptionPeriod` - # @return [String] - attr_accessor :subscription_period - - # Trial period, specified in ISO 8601 format. Acceptable values are anything - # between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions - # cannot have a trial period. - # Corresponds to the JSON property `trialPeriod` - # @return [String] - attr_accessor :trial_period - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @default_language = args[:default_language] if args.key?(:default_language) - @default_price = args[:default_price] if args.key?(:default_price) - @grace_period = args[:grace_period] if args.key?(:grace_period) - @listings = args[:listings] if args.key?(:listings) - @package_name = args[:package_name] if args.key?(:package_name) - @prices = args[:prices] if args.key?(:prices) - @purchase_type = args[:purchase_type] if args.key?(:purchase_type) - @sku = args[:sku] if args.key?(:sku) - @status = args[:status] if args.key?(:status) - @subscription_period = args[:subscription_period] if args.key?(:subscription_period) - @trial_period = args[:trial_period] if args.key?(:trial_period) - end - end - - # - class InAppProductListing - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # - # 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) - @title = args[:title] if args.key?(:title) - end - end - - # - class ListInAppProductsResponse - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `inappproduct` - # @return [Array] - attr_accessor :inappproduct - - # Identifies what kind of resource this is. Value: the fixed string " - # androidpublisher#inappproductsListResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # - # Corresponds to the JSON property `pageInfo` - # @return [Google::Apis::AndroidpublisherV2::PageInfo] - attr_accessor :page_info - - # - # Corresponds to the JSON property `tokenPagination` - # @return [Google::Apis::AndroidpublisherV2::TokenPagination] - attr_accessor :token_pagination - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @inappproduct = args[:inappproduct] if args.key?(:inappproduct) - @kind = args[:kind] if args.key?(:kind) - @page_info = args[:page_info] if args.key?(:page_info) - @token_pagination = args[:token_pagination] if args.key?(:token_pagination) - end - end - - # - class Listing - include Google::Apis::Core::Hashable - - # Full description of the app; this may be up to 4000 characters in length. - # Corresponds to the JSON property `fullDescription` - # @return [String] - attr_accessor :full_description - - # Language localization code (for example, "de-AT" for Austrian German). - # Corresponds to the JSON property `language` - # @return [String] - attr_accessor :language - - # Short description of the app (previously known as promo text); this may be up - # to 80 characters in length. - # Corresponds to the JSON property `shortDescription` - # @return [String] - attr_accessor :short_description - - # App's localized title. - # Corresponds to the JSON property `title` - # @return [String] - attr_accessor :title - - # URL of a promotional YouTube video for the app. - # Corresponds to the JSON property `video` - # @return [String] - attr_accessor :video - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @full_description = args[:full_description] if args.key?(:full_description) - @language = args[:language] if args.key?(:language) - @short_description = args[:short_description] if args.key?(:short_description) - @title = args[:title] if args.key?(:title) - @video = args[:video] if args.key?(:video) - end - end - - # - class ListListingsResponse - include Google::Apis::Core::Hashable - - # Identifies what kind of resource this is. Value: the fixed string " - # androidpublisher#listingsListResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # - # Corresponds to the JSON property `listings` - # @return [Array] - attr_accessor :listings - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @listings = args[:listings] if args.key?(:listings) - end - end - # class PageInfo include Google::Apis::Core::Hashable @@ -1012,31 +53,6 @@ module Google end end - # - class Price - include Google::Apis::Core::Hashable - - # 3 letter Currency code, as defined by ISO 4217. - # Corresponds to the JSON property `currency` - # @return [String] - attr_accessor :currency - - # The price in millionths of the currency base unit represented as a string. - # Corresponds to the JSON property `priceMicros` - # @return [String] - attr_accessor :price_micros - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @currency = args[:currency] if args.key?(:currency) - @price_micros = args[:price_micros] if args.key?(:price_micros) - end - end - # A ProductPurchase resource indicates the status of a user's inapp product # purchase. class ProductPurchase @@ -1105,496 +121,6 @@ module Google end end - # - class Review - include Google::Apis::Core::Hashable - - # The name of the user who wrote the review. - # Corresponds to the JSON property `authorName` - # @return [String] - attr_accessor :author_name - - # A repeated field containing comments for the review. - # Corresponds to the JSON property `comments` - # @return [Array] - attr_accessor :comments - - # Unique identifier for this review. - # Corresponds to the JSON property `reviewId` - # @return [String] - attr_accessor :review_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @author_name = args[:author_name] if args.key?(:author_name) - @comments = args[:comments] if args.key?(:comments) - @review_id = args[:review_id] if args.key?(:review_id) - end - end - - # - class ReviewReplyResult - include Google::Apis::Core::Hashable - - # The time at which the reply took effect. - # Corresponds to the JSON property `lastEdited` - # @return [Google::Apis::AndroidpublisherV2::Timestamp] - attr_accessor :last_edited - - # The reply text that was applied. - # Corresponds to the JSON property `replyText` - # @return [String] - attr_accessor :reply_text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @last_edited = args[:last_edited] if args.key?(:last_edited) - @reply_text = args[:reply_text] if args.key?(:reply_text) - end - end - - # - class ReviewsListResponse - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `pageInfo` - # @return [Google::Apis::AndroidpublisherV2::PageInfo] - attr_accessor :page_info - - # - # Corresponds to the JSON property `reviews` - # @return [Array] - attr_accessor :reviews - - # - # Corresponds to the JSON property `tokenPagination` - # @return [Google::Apis::AndroidpublisherV2::TokenPagination] - attr_accessor :token_pagination - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @page_info = args[:page_info] if args.key?(:page_info) - @reviews = args[:reviews] if args.key?(:reviews) - @token_pagination = args[:token_pagination] if args.key?(:token_pagination) - end - end - - # - class ReviewsReplyRequest - include Google::Apis::Core::Hashable - - # The text to set as the reply. Replies of more than approximately 350 - # characters will be rejected. HTML tags will be stripped. - # Corresponds to the JSON property `replyText` - # @return [String] - attr_accessor :reply_text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @reply_text = args[:reply_text] if args.key?(:reply_text) - end - end - - # - class ReviewsReplyResponse - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `result` - # @return [Google::Apis::AndroidpublisherV2::ReviewReplyResult] - attr_accessor :result - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @result = args[:result] if args.key?(:result) - end - end - - # Information provided by the user when they complete the subscription - # cancellation flow (cancellation reason survey). - class SubscriptionCancelSurveyResult - include Google::Apis::Core::Hashable - - # The cancellation reason the user chose in the survey. Possible values are: - # - Other - # - I don't use this service enough - # - Technical issues - # - Cost-related reasons - # - I found a better app - # Corresponds to the JSON property `cancelSurveyReason` - # @return [Fixnum] - attr_accessor :cancel_survey_reason - - # The customized input cancel reason from the user. Only present when - # cancelReason is 0. - # Corresponds to the JSON property `userInputCancelReason` - # @return [String] - attr_accessor :user_input_cancel_reason - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @cancel_survey_reason = args[:cancel_survey_reason] if args.key?(:cancel_survey_reason) - @user_input_cancel_reason = args[:user_input_cancel_reason] if args.key?(:user_input_cancel_reason) - end - end - - # A SubscriptionDeferralInfo contains the data needed to defer a subscription - # purchase to a future expiry time. - class SubscriptionDeferralInfo - include Google::Apis::Core::Hashable - - # The desired next expiry time to assign to the subscription, in milliseconds - # since the Epoch. The given time must be later/greater than the current expiry - # time for the subscription. - # Corresponds to the JSON property `desiredExpiryTimeMillis` - # @return [Fixnum] - attr_accessor :desired_expiry_time_millis - - # The expected expiry time for the subscription. If the current expiry time for - # the subscription is not the value specified here, the deferral will not occur. - # Corresponds to the JSON property `expectedExpiryTimeMillis` - # @return [Fixnum] - attr_accessor :expected_expiry_time_millis - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @desired_expiry_time_millis = args[:desired_expiry_time_millis] if args.key?(:desired_expiry_time_millis) - @expected_expiry_time_millis = args[:expected_expiry_time_millis] if args.key?(:expected_expiry_time_millis) - end - end - - # Contains the price change information for a subscription that can be used to - # control the user journey for the price change in the app. This can be in the - # form of seeking confirmation from the user or tailoring the experience for a - # successful conversion. - class SubscriptionPriceChange - include Google::Apis::Core::Hashable - - # The new price the subscription will renew with if the price change is accepted - # by the user. - # Corresponds to the JSON property `newPrice` - # @return [Google::Apis::AndroidpublisherV2::Price] - attr_accessor :new_price - - # The current state of the price change. Possible values are: - # - Outstanding: State for a pending price change waiting for the user to agree. - # In this state, you can optionally seek confirmation from the user using the In- - # App API. - # - Accepted: State for an accepted price change that the subscription will - # renew with unless it's canceled. The price change takes effect on a future - # date when the subscription renews. Note that the change might not occur when - # the subscription is renewed next. - # Corresponds to the JSON property `state` - # @return [Fixnum] - attr_accessor :state - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @new_price = args[:new_price] if args.key?(:new_price) - @state = args[:state] if args.key?(:state) - end - end - - # A SubscriptionPurchase resource indicates the status of a user's subscription - # purchase. - class SubscriptionPurchase - include Google::Apis::Core::Hashable - - # Whether the subscription will automatically be renewed when it reaches its - # current expiry time. - # Corresponds to the JSON property `autoRenewing` - # @return [Boolean] - attr_accessor :auto_renewing - alias_method :auto_renewing?, :auto_renewing - - # The reason why a subscription was canceled or is not auto-renewing. Possible - # values are: - # - User canceled the subscription - # - Subscription was canceled by the system, for example because of a billing - # problem - # - Subscription was replaced with a new subscription - # - Subscription was canceled by the developer - # Corresponds to the JSON property `cancelReason` - # @return [Fixnum] - attr_accessor :cancel_reason - - # Information provided by the user when they complete the subscription - # cancellation flow (cancellation reason survey). - # Corresponds to the JSON property `cancelSurveyResult` - # @return [Google::Apis::AndroidpublisherV2::SubscriptionCancelSurveyResult] - attr_accessor :cancel_survey_result - - # ISO 3166-1 alpha-2 billing country/region code of the user at the time the - # subscription was granted. - # Corresponds to the JSON property `countryCode` - # @return [String] - attr_accessor :country_code - - # A developer-specified string that contains supplemental information about an - # order. - # Corresponds to the JSON property `developerPayload` - # @return [String] - attr_accessor :developer_payload - - # The email address of the user when the subscription was purchased. Only - # present for purchases made with 'Subscribe with Google'. - # Corresponds to the JSON property `emailAddress` - # @return [String] - attr_accessor :email_address - - # Time at which the subscription will expire, in milliseconds since the Epoch. - # Corresponds to the JSON property `expiryTimeMillis` - # @return [Fixnum] - attr_accessor :expiry_time_millis - - # The family name of the user when the subscription was purchased. Only present - # for purchases made with 'Subscribe with Google'. - # Corresponds to the JSON property `familyName` - # @return [String] - attr_accessor :family_name - - # The given name of the user when the subscription was purchased. Only present - # for purchases made with 'Subscribe with Google'. - # Corresponds to the JSON property `givenName` - # @return [String] - attr_accessor :given_name - - # This kind represents a subscriptionPurchase object in the androidpublisher - # service. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The purchase token of the originating purchase if this subscription is one of - # the following: - # - Re-signup of a canceled but non-lapsed subscription - # - Upgrade/downgrade from a previous subscription For example, suppose a user - # originally signs up and you receive purchase token X, then the user cancels - # and goes through the resignup flow (before their subscription lapses) and you - # receive purchase token Y, and finally the user upgrades their subscription and - # you receive purchase token Z. If you call this API with purchase token Z, this - # field will be set to Y. If you call this API with purchase token Y, this field - # will be set to X. If you call this API with purchase token X, this field will - # not be set. - # Corresponds to the JSON property `linkedPurchaseToken` - # @return [String] - attr_accessor :linked_purchase_token - - # The order id of the latest recurring order associated with the purchase of the - # subscription. - # Corresponds to the JSON property `orderId` - # @return [String] - attr_accessor :order_id - - # The payment state of the subscription. Possible values are: - # - Payment pending - # - Payment received - # - Free trial - # - Pending deferred upgrade/downgrade - # Corresponds to the JSON property `paymentState` - # @return [Fixnum] - attr_accessor :payment_state - - # Price of the subscription, not including tax. Price is expressed in micro- - # units, where 1,000,000 micro-units represents one unit of the currency. For - # example, if the subscription price is €1.99, price_amount_micros is 1990000. - # Corresponds to the JSON property `priceAmountMicros` - # @return [Fixnum] - attr_accessor :price_amount_micros - - # Contains the price change information for a subscription that can be used to - # control the user journey for the price change in the app. This can be in the - # form of seeking confirmation from the user or tailoring the experience for a - # successful conversion. - # Corresponds to the JSON property `priceChange` - # @return [Google::Apis::AndroidpublisherV2::SubscriptionPriceChange] - attr_accessor :price_change - - # ISO 4217 currency code for the subscription price. For example, if the price - # is specified in British pounds sterling, price_currency_code is "GBP". - # Corresponds to the JSON property `priceCurrencyCode` - # @return [String] - attr_accessor :price_currency_code - - # The Google profile id of the user when the subscription was purchased. Only - # present for purchases made with 'Subscribe with Google'. - # Corresponds to the JSON property `profileId` - # @return [String] - attr_accessor :profile_id - - # The profile name of the user when the subscription was purchased. Only present - # for purchases made with 'Subscribe with Google'. - # Corresponds to the JSON property `profileName` - # @return [String] - attr_accessor :profile_name - - # The type of purchase of the subscription. This field is only set if this - # purchase was not made using the standard in-app billing flow. Possible values - # are: - # - Test (i.e. purchased from a license testing account) - # - Promo (i.e. purchased using a promo code) - # Corresponds to the JSON property `purchaseType` - # @return [Fixnum] - attr_accessor :purchase_type - - # Time at which the subscription was granted, in milliseconds since the Epoch. - # Corresponds to the JSON property `startTimeMillis` - # @return [Fixnum] - attr_accessor :start_time_millis - - # The time at which the subscription was canceled by the user, in milliseconds - # since the epoch. Only present if cancelReason is 0. - # Corresponds to the JSON property `userCancellationTimeMillis` - # @return [Fixnum] - attr_accessor :user_cancellation_time_millis - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @auto_renewing = args[:auto_renewing] if args.key?(:auto_renewing) - @cancel_reason = args[:cancel_reason] if args.key?(:cancel_reason) - @cancel_survey_result = args[:cancel_survey_result] if args.key?(:cancel_survey_result) - @country_code = args[:country_code] if args.key?(:country_code) - @developer_payload = args[:developer_payload] if args.key?(:developer_payload) - @email_address = args[:email_address] if args.key?(:email_address) - @expiry_time_millis = args[:expiry_time_millis] if args.key?(:expiry_time_millis) - @family_name = args[:family_name] if args.key?(:family_name) - @given_name = args[:given_name] if args.key?(:given_name) - @kind = args[:kind] if args.key?(:kind) - @linked_purchase_token = args[:linked_purchase_token] if args.key?(:linked_purchase_token) - @order_id = args[:order_id] if args.key?(:order_id) - @payment_state = args[:payment_state] if args.key?(:payment_state) - @price_amount_micros = args[:price_amount_micros] if args.key?(:price_amount_micros) - @price_change = args[:price_change] if args.key?(:price_change) - @price_currency_code = args[:price_currency_code] if args.key?(:price_currency_code) - @profile_id = args[:profile_id] if args.key?(:profile_id) - @profile_name = args[:profile_name] if args.key?(:profile_name) - @purchase_type = args[:purchase_type] if args.key?(:purchase_type) - @start_time_millis = args[:start_time_millis] if args.key?(:start_time_millis) - @user_cancellation_time_millis = args[:user_cancellation_time_millis] if args.key?(:user_cancellation_time_millis) - end - end - - # - class DeferSubscriptionPurchasesRequest - include Google::Apis::Core::Hashable - - # A SubscriptionDeferralInfo contains the data needed to defer a subscription - # purchase to a future expiry time. - # Corresponds to the JSON property `deferralInfo` - # @return [Google::Apis::AndroidpublisherV2::SubscriptionDeferralInfo] - attr_accessor :deferral_info - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @deferral_info = args[:deferral_info] if args.key?(:deferral_info) - end - end - - # - class DeferSubscriptionPurchasesResponse - include Google::Apis::Core::Hashable - - # The new expiry time for the subscription in milliseconds since the Epoch. - # Corresponds to the JSON property `newExpiryTimeMillis` - # @return [Fixnum] - attr_accessor :new_expiry_time_millis - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @new_expiry_time_millis = args[:new_expiry_time_millis] if args.key?(:new_expiry_time_millis) - end - end - - # - class Testers - include Google::Apis::Core::Hashable - - # A list of all Google Groups, as email addresses, that define testers for this - # track. - # Corresponds to the JSON property `googleGroups` - # @return [Array] - attr_accessor :google_groups - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @google_groups = args[:google_groups] if args.key?(:google_groups) - end - end - - # - class Timestamp - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `nanos` - # @return [Fixnum] - attr_accessor :nanos - - # - # Corresponds to the JSON property `seconds` - # @return [Fixnum] - attr_accessor :seconds - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @nanos = args[:nanos] if args.key?(:nanos) - @seconds = args[:seconds] if args.key?(:seconds) - end - end - # class TokenPagination include Google::Apis::Core::Hashable @@ -1620,157 +146,6 @@ module Google end end - # - class Track - include Google::Apis::Core::Hashable - - # Identifier for this track. - # Corresponds to the JSON property `track` - # @return [String] - attr_accessor :track - - # - # Corresponds to the JSON property `userFraction` - # @return [Float] - attr_accessor :user_fraction - - # Version codes to make active on this track. Note that this list should contain - # all versions you wish to be active, including those you wish to retain from - # previous releases. - # Corresponds to the JSON property `versionCodes` - # @return [Array] - attr_accessor :version_codes - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @track = args[:track] if args.key?(:track) - @user_fraction = args[:user_fraction] if args.key?(:user_fraction) - @version_codes = args[:version_codes] if args.key?(:version_codes) - end - end - - # - class ListTracksResponse - include Google::Apis::Core::Hashable - - # Identifies what kind of resource this is. Value: the fixed string " - # androidpublisher#tracksListResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # - # Corresponds to the JSON property `tracks` - # @return [Array] - attr_accessor :tracks - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @tracks = args[:tracks] if args.key?(:tracks) - end - end - - # - class UserComment - include Google::Apis::Core::Hashable - - # Integer Android SDK version of the user's device at the time the review was - # written, e.g. 23 is Marshmallow. May be absent. - # Corresponds to the JSON property `androidOsVersion` - # @return [Fixnum] - attr_accessor :android_os_version - - # Integer version code of the app as installed at the time the review was - # written. May be absent. - # Corresponds to the JSON property `appVersionCode` - # @return [Fixnum] - attr_accessor :app_version_code - - # String version name of the app as installed at the time the review was written. - # May be absent. - # Corresponds to the JSON property `appVersionName` - # @return [String] - attr_accessor :app_version_name - - # Codename for the reviewer's device, e.g. klte, flounder. May be absent. - # Corresponds to the JSON property `device` - # @return [String] - attr_accessor :device - - # Some information about the characteristics of the user's device - # Corresponds to the JSON property `deviceMetadata` - # @return [Google::Apis::AndroidpublisherV2::DeviceMetadata] - attr_accessor :device_metadata - - # The last time at which this comment was updated. - # Corresponds to the JSON property `lastModified` - # @return [Google::Apis::AndroidpublisherV2::Timestamp] - attr_accessor :last_modified - - # Untranslated text of the review, in the case where the review has been - # translated. If the review has not been translated this is left blank. - # Corresponds to the JSON property `originalText` - # @return [String] - attr_accessor :original_text - - # Language code for the reviewer. This is taken from the device settings so is - # not guaranteed to match the language the review is written in. May be absent. - # Corresponds to the JSON property `reviewerLanguage` - # @return [String] - attr_accessor :reviewer_language - - # The star rating associated with the review, from 1 to 5. - # Corresponds to the JSON property `starRating` - # @return [Fixnum] - attr_accessor :star_rating - - # The content of the comment, i.e. review body. In some cases users have been - # able to write a review with separate title and body; in those cases the title - # and body are concatenated and separated by a tab character. - # Corresponds to the JSON property `text` - # @return [String] - attr_accessor :text - - # Number of users who have given this review a thumbs down - # Corresponds to the JSON property `thumbsDownCount` - # @return [Fixnum] - attr_accessor :thumbs_down_count - - # Number of users who have given this review a thumbs up - # Corresponds to the JSON property `thumbsUpCount` - # @return [Fixnum] - attr_accessor :thumbs_up_count - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @android_os_version = args[:android_os_version] if args.key?(:android_os_version) - @app_version_code = args[:app_version_code] if args.key?(:app_version_code) - @app_version_name = args[:app_version_name] if args.key?(:app_version_name) - @device = args[:device] if args.key?(:device) - @device_metadata = args[:device_metadata] if args.key?(:device_metadata) - @last_modified = args[:last_modified] if args.key?(:last_modified) - @original_text = args[:original_text] if args.key?(:original_text) - @reviewer_language = args[:reviewer_language] if args.key?(:reviewer_language) - @star_rating = args[:star_rating] if args.key?(:star_rating) - @text = args[:text] if args.key?(:text) - @thumbs_down_count = args[:thumbs_down_count] if args.key?(:thumbs_down_count) - @thumbs_up_count = args[:thumbs_up_count] if args.key?(:thumbs_up_count) - end - end - # A VoidedPurchase resource indicates a purchase that was either canceled/ # refunded/charged-back. class VoidedPurchase diff --git a/generated/google/apis/androidpublisher_v2/representations.rb b/generated/google/apis/androidpublisher_v2/representations.rb index 2999b3b4f..5e609df90 100644 --- a/generated/google/apis/androidpublisher_v2/representations.rb +++ b/generated/google/apis/androidpublisher_v2/representations.rb @@ -22,300 +22,24 @@ module Google module Apis module AndroidpublisherV2 - class Apk - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ApkBinary - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ApkListing - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListApkListingsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ApksAddExternallyHostedRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ApksAddExternallyHostedResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListApksResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AppDetails - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AppEdit - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Bundle - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class BundlesListResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Comment - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DeobfuscationFile - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DeobfuscationFilesUploadResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DeveloperComment - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DeviceMetadata - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ExpansionFile - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class UploadExpansionFilesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ExternallyHostedApk - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ExternallyHostedApkUsesPermission - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Image - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DeleteAllImagesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListImagesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class UploadImagesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class InAppProduct - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class InAppProductListing - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListInAppProductsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Listing - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListListingsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class PageInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class Price - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class ProductPurchase class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class Review - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ReviewReplyResult - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ReviewsListResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ReviewsReplyRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ReviewsReplyResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SubscriptionCancelSurveyResult - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SubscriptionDeferralInfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SubscriptionPriceChange - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SubscriptionPurchase - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DeferSubscriptionPurchasesRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DeferSubscriptionPurchasesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Testers - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Timestamp - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class TokenPagination class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class Track - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListTracksResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class UserComment - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class VoidedPurchase class Representation < Google::Apis::Core::JsonRepresentation; end @@ -328,293 +52,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class Apk - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :binary, as: 'binary', class: Google::Apis::AndroidpublisherV2::ApkBinary, decorator: Google::Apis::AndroidpublisherV2::ApkBinary::Representation - - property :version_code, as: 'versionCode' - end - end - - class ApkBinary - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :sha1, as: 'sha1' - property :sha256, as: 'sha256' - end - end - - class ApkListing - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :language, as: 'language' - property :recent_changes, as: 'recentChanges' - end - end - - class ListApkListingsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - collection :listings, as: 'listings', class: Google::Apis::AndroidpublisherV2::ApkListing, decorator: Google::Apis::AndroidpublisherV2::ApkListing::Representation - - end - end - - class ApksAddExternallyHostedRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :externally_hosted_apk, as: 'externallyHostedApk', class: Google::Apis::AndroidpublisherV2::ExternallyHostedApk, decorator: Google::Apis::AndroidpublisherV2::ExternallyHostedApk::Representation - - end - end - - class ApksAddExternallyHostedResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :externally_hosted_apk, as: 'externallyHostedApk', class: Google::Apis::AndroidpublisherV2::ExternallyHostedApk, decorator: Google::Apis::AndroidpublisherV2::ExternallyHostedApk::Representation - - end - end - - class ListApksResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :apks, as: 'apks', class: Google::Apis::AndroidpublisherV2::Apk, decorator: Google::Apis::AndroidpublisherV2::Apk::Representation - - property :kind, as: 'kind' - end - end - - class AppDetails - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :contact_email, as: 'contactEmail' - property :contact_phone, as: 'contactPhone' - property :contact_website, as: 'contactWebsite' - property :default_language, as: 'defaultLanguage' - end - end - - class AppEdit - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :expiry_time_seconds, as: 'expiryTimeSeconds' - property :id, as: 'id' - end - end - - class Bundle - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :sha1, as: 'sha1' - property :sha256, as: 'sha256' - property :version_code, as: 'versionCode' - end - end - - class BundlesListResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :bundles, as: 'bundles', class: Google::Apis::AndroidpublisherV2::Bundle, decorator: Google::Apis::AndroidpublisherV2::Bundle::Representation - - property :kind, as: 'kind' - end - end - - class Comment - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :developer_comment, as: 'developerComment', class: Google::Apis::AndroidpublisherV2::DeveloperComment, decorator: Google::Apis::AndroidpublisherV2::DeveloperComment::Representation - - property :user_comment, as: 'userComment', class: Google::Apis::AndroidpublisherV2::UserComment, decorator: Google::Apis::AndroidpublisherV2::UserComment::Representation - - end - end - - class DeobfuscationFile - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :symbol_type, as: 'symbolType' - end - end - - class DeobfuscationFilesUploadResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :deobfuscation_file, as: 'deobfuscationFile', class: Google::Apis::AndroidpublisherV2::DeobfuscationFile, decorator: Google::Apis::AndroidpublisherV2::DeobfuscationFile::Representation - - end - end - - class DeveloperComment - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :last_modified, as: 'lastModified', class: Google::Apis::AndroidpublisherV2::Timestamp, decorator: Google::Apis::AndroidpublisherV2::Timestamp::Representation - - property :text, as: 'text' - end - end - - class DeviceMetadata - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :cpu_make, as: 'cpuMake' - property :cpu_model, as: 'cpuModel' - property :device_class, as: 'deviceClass' - property :gl_es_version, as: 'glEsVersion' - property :manufacturer, as: 'manufacturer' - property :native_platform, as: 'nativePlatform' - property :product_name, as: 'productName' - property :ram_mb, as: 'ramMb' - property :screen_density_dpi, as: 'screenDensityDpi' - property :screen_height_px, as: 'screenHeightPx' - property :screen_width_px, as: 'screenWidthPx' - end - end - - class ExpansionFile - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :file_size, :numeric_string => true, as: 'fileSize' - property :references_version, as: 'referencesVersion' - end - end - - class UploadExpansionFilesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :expansion_file, as: 'expansionFile', class: Google::Apis::AndroidpublisherV2::ExpansionFile, decorator: Google::Apis::AndroidpublisherV2::ExpansionFile::Representation - - end - end - - class ExternallyHostedApk - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :application_label, as: 'applicationLabel' - collection :certificate_base64s, as: 'certificateBase64s' - property :externally_hosted_url, as: 'externallyHostedUrl' - property :file_sha1_base64, as: 'fileSha1Base64' - property :file_sha256_base64, as: 'fileSha256Base64' - property :file_size, :numeric_string => true, as: 'fileSize' - property :icon_base64, as: 'iconBase64' - property :maximum_sdk, as: 'maximumSdk' - property :minimum_sdk, as: 'minimumSdk' - collection :native_codes, as: 'nativeCodes' - property :package_name, as: 'packageName' - collection :uses_features, as: 'usesFeatures' - collection :uses_permissions, as: 'usesPermissions', class: Google::Apis::AndroidpublisherV2::ExternallyHostedApkUsesPermission, decorator: Google::Apis::AndroidpublisherV2::ExternallyHostedApkUsesPermission::Representation - - property :version_code, as: 'versionCode' - property :version_name, as: 'versionName' - end - end - - class ExternallyHostedApkUsesPermission - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :max_sdk_version, as: 'maxSdkVersion' - property :name, as: 'name' - end - end - - class Image - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :id, as: 'id' - property :sha1, as: 'sha1' - property :sha256, as: 'sha256' - property :url, as: 'url' - end - end - - class DeleteAllImagesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :deleted, as: 'deleted', class: Google::Apis::AndroidpublisherV2::Image, decorator: Google::Apis::AndroidpublisherV2::Image::Representation - - end - end - - class ListImagesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :images, as: 'images', class: Google::Apis::AndroidpublisherV2::Image, decorator: Google::Apis::AndroidpublisherV2::Image::Representation - - end - end - - class UploadImagesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :image, as: 'image', class: Google::Apis::AndroidpublisherV2::Image, decorator: Google::Apis::AndroidpublisherV2::Image::Representation - - end - end - - class InAppProduct - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :default_language, as: 'defaultLanguage' - property :default_price, as: 'defaultPrice', class: Google::Apis::AndroidpublisherV2::Price, decorator: Google::Apis::AndroidpublisherV2::Price::Representation - - property :grace_period, as: 'gracePeriod' - hash :listings, as: 'listings', class: Google::Apis::AndroidpublisherV2::InAppProductListing, decorator: Google::Apis::AndroidpublisherV2::InAppProductListing::Representation - - property :package_name, as: 'packageName' - hash :prices, as: 'prices', class: Google::Apis::AndroidpublisherV2::Price, decorator: Google::Apis::AndroidpublisherV2::Price::Representation - - property :purchase_type, as: 'purchaseType' - property :sku, as: 'sku' - property :status, as: 'status' - property :subscription_period, as: 'subscriptionPeriod' - property :trial_period, as: 'trialPeriod' - end - end - - class InAppProductListing - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :description, as: 'description' - property :title, as: 'title' - end - end - - class ListInAppProductsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :inappproduct, as: 'inappproduct', class: Google::Apis::AndroidpublisherV2::InAppProduct, decorator: Google::Apis::AndroidpublisherV2::InAppProduct::Representation - - property :kind, as: 'kind' - property :page_info, as: 'pageInfo', class: Google::Apis::AndroidpublisherV2::PageInfo, decorator: Google::Apis::AndroidpublisherV2::PageInfo::Representation - - property :token_pagination, as: 'tokenPagination', class: Google::Apis::AndroidpublisherV2::TokenPagination, decorator: Google::Apis::AndroidpublisherV2::TokenPagination::Representation - - end - end - - class Listing - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :full_description, as: 'fullDescription' - property :language, as: 'language' - property :short_description, as: 'shortDescription' - property :title, as: 'title' - property :video, as: 'video' - end - end - - class ListListingsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - collection :listings, as: 'listings', class: Google::Apis::AndroidpublisherV2::Listing, decorator: Google::Apis::AndroidpublisherV2::Listing::Representation - - end - end - class PageInfo # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -624,14 +61,6 @@ module Google end end - class Price - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :currency, as: 'currency' - property :price_micros, as: 'priceMicros' - end - end - class ProductPurchase # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -645,136 +74,6 @@ module Google end end - class Review - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :author_name, as: 'authorName' - collection :comments, as: 'comments', class: Google::Apis::AndroidpublisherV2::Comment, decorator: Google::Apis::AndroidpublisherV2::Comment::Representation - - property :review_id, as: 'reviewId' - end - end - - class ReviewReplyResult - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :last_edited, as: 'lastEdited', class: Google::Apis::AndroidpublisherV2::Timestamp, decorator: Google::Apis::AndroidpublisherV2::Timestamp::Representation - - property :reply_text, as: 'replyText' - end - end - - class ReviewsListResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :page_info, as: 'pageInfo', class: Google::Apis::AndroidpublisherV2::PageInfo, decorator: Google::Apis::AndroidpublisherV2::PageInfo::Representation - - collection :reviews, as: 'reviews', class: Google::Apis::AndroidpublisherV2::Review, decorator: Google::Apis::AndroidpublisherV2::Review::Representation - - property :token_pagination, as: 'tokenPagination', class: Google::Apis::AndroidpublisherV2::TokenPagination, decorator: Google::Apis::AndroidpublisherV2::TokenPagination::Representation - - end - end - - class ReviewsReplyRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :reply_text, as: 'replyText' - end - end - - class ReviewsReplyResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :result, as: 'result', class: Google::Apis::AndroidpublisherV2::ReviewReplyResult, decorator: Google::Apis::AndroidpublisherV2::ReviewReplyResult::Representation - - end - end - - class SubscriptionCancelSurveyResult - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :cancel_survey_reason, as: 'cancelSurveyReason' - property :user_input_cancel_reason, as: 'userInputCancelReason' - end - end - - class SubscriptionDeferralInfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :desired_expiry_time_millis, :numeric_string => true, as: 'desiredExpiryTimeMillis' - property :expected_expiry_time_millis, :numeric_string => true, as: 'expectedExpiryTimeMillis' - end - end - - class SubscriptionPriceChange - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :new_price, as: 'newPrice', class: Google::Apis::AndroidpublisherV2::Price, decorator: Google::Apis::AndroidpublisherV2::Price::Representation - - property :state, as: 'state' - end - end - - class SubscriptionPurchase - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :auto_renewing, as: 'autoRenewing' - property :cancel_reason, as: 'cancelReason' - property :cancel_survey_result, as: 'cancelSurveyResult', class: Google::Apis::AndroidpublisherV2::SubscriptionCancelSurveyResult, decorator: Google::Apis::AndroidpublisherV2::SubscriptionCancelSurveyResult::Representation - - property :country_code, as: 'countryCode' - property :developer_payload, as: 'developerPayload' - property :email_address, as: 'emailAddress' - property :expiry_time_millis, :numeric_string => true, as: 'expiryTimeMillis' - property :family_name, as: 'familyName' - property :given_name, as: 'givenName' - property :kind, as: 'kind' - property :linked_purchase_token, as: 'linkedPurchaseToken' - property :order_id, as: 'orderId' - property :payment_state, as: 'paymentState' - property :price_amount_micros, :numeric_string => true, as: 'priceAmountMicros' - property :price_change, as: 'priceChange', class: Google::Apis::AndroidpublisherV2::SubscriptionPriceChange, decorator: Google::Apis::AndroidpublisherV2::SubscriptionPriceChange::Representation - - property :price_currency_code, as: 'priceCurrencyCode' - property :profile_id, as: 'profileId' - property :profile_name, as: 'profileName' - property :purchase_type, as: 'purchaseType' - property :start_time_millis, :numeric_string => true, as: 'startTimeMillis' - property :user_cancellation_time_millis, :numeric_string => true, as: 'userCancellationTimeMillis' - end - end - - class DeferSubscriptionPurchasesRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :deferral_info, as: 'deferralInfo', class: Google::Apis::AndroidpublisherV2::SubscriptionDeferralInfo, decorator: Google::Apis::AndroidpublisherV2::SubscriptionDeferralInfo::Representation - - end - end - - class DeferSubscriptionPurchasesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :new_expiry_time_millis, :numeric_string => true, as: 'newExpiryTimeMillis' - end - end - - class Testers - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :google_groups, as: 'googleGroups' - end - end - - class Timestamp - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :nanos, as: 'nanos' - property :seconds, :numeric_string => true, as: 'seconds' - end - end - class TokenPagination # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -783,44 +82,6 @@ module Google end end - class Track - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :track, as: 'track' - property :user_fraction, as: 'userFraction' - collection :version_codes, as: 'versionCodes' - end - end - - class ListTracksResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - collection :tracks, as: 'tracks', class: Google::Apis::AndroidpublisherV2::Track, decorator: Google::Apis::AndroidpublisherV2::Track::Representation - - end - end - - class UserComment - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :android_os_version, as: 'androidOsVersion' - property :app_version_code, as: 'appVersionCode' - property :app_version_name, as: 'appVersionName' - property :device, as: 'device' - property :device_metadata, as: 'deviceMetadata', class: Google::Apis::AndroidpublisherV2::DeviceMetadata, decorator: Google::Apis::AndroidpublisherV2::DeviceMetadata::Representation - - property :last_modified, as: 'lastModified', class: Google::Apis::AndroidpublisherV2::Timestamp, decorator: Google::Apis::AndroidpublisherV2::Timestamp::Representation - - property :original_text, as: 'originalText' - property :reviewer_language, as: 'reviewerLanguage' - property :star_rating, as: 'starRating' - property :text, as: 'text' - property :thumbs_down_count, as: 'thumbsDownCount' - property :thumbs_up_count, as: 'thumbsUpCount' - end - end - class VoidedPurchase # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/androidpublisher_v2/service.rb b/generated/google/apis/androidpublisher_v2/service.rb index 6991aecfd..38880ec0b 100644 --- a/generated/google/apis/androidpublisher_v2/service.rb +++ b/generated/google/apis/androidpublisher_v2/service.rb @@ -51,2045 +51,6 @@ module Google @batch_path = 'batch/androidpublisher/v2' end - # Commits/applies the changes made in this edit back to the app. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::AppEdit] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::AppEdit] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def commit_edit(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{packageName}/edits/{editId}:commit', options) - command.response_representation = Google::Apis::AndroidpublisherV2::AppEdit::Representation - command.response_class = Google::Apis::AndroidpublisherV2::AppEdit - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Deletes an edit for an app. Creating a new edit will automatically delete any - # of your previous edits so this method need only be called if you want to - # preemptively abandon an edit. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_edit(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, '{packageName}/edits/{editId}', options) - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Returns information about the edit specified. Calls will fail if the edit is - # no long active (e.g. has been deleted, superseded or expired). - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::AppEdit] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::AppEdit] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_edit(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{packageName}/edits/{editId}', options) - command.response_representation = Google::Apis::AndroidpublisherV2::AppEdit::Representation - command.response_class = Google::Apis::AndroidpublisherV2::AppEdit - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Creates a new edit for an app, populated with the app's current state. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [Google::Apis::AndroidpublisherV2::AppEdit] app_edit_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::AppEdit] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::AppEdit] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_edit(package_name, app_edit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{packageName}/edits', options) - command.request_representation = Google::Apis::AndroidpublisherV2::AppEdit::Representation - command.request_object = app_edit_object - command.response_representation = Google::Apis::AndroidpublisherV2::AppEdit::Representation - command.response_class = Google::Apis::AndroidpublisherV2::AppEdit - command.params['packageName'] = package_name unless package_name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Checks that the edit can be successfully committed. The edit's changes are not - # applied to the live app. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::AppEdit] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::AppEdit] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def validate_edit(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{packageName}/edits/{editId}:validate', options) - command.response_representation = Google::Apis::AndroidpublisherV2::AppEdit::Representation - command.response_class = Google::Apis::AndroidpublisherV2::AppEdit - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Deletes the APK-specific localized listing for a specified APK and language - # code. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [Fixnum] apk_version_code - # The APK version code whose APK-specific listings should be read or modified. - # @param [String] language - # The language code (a BCP-47 language tag) of the APK-specific localized - # listing to read or modify. For example, to select Austrian German, pass "de-AT" - # . - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_apk_listing(package_name, edit_id, apk_version_code, language, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, '{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}', options) - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['apkVersionCode'] = apk_version_code unless apk_version_code.nil? - command.params['language'] = language unless language.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Deletes all the APK-specific localized listings for a specified APK. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [Fixnum] apk_version_code - # The APK version code whose APK-specific listings should be read or modified. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_all_apk_listings(package_name, edit_id, apk_version_code, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, '{packageName}/edits/{editId}/apks/{apkVersionCode}/listings', options) - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['apkVersionCode'] = apk_version_code unless apk_version_code.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Fetches the APK-specific localized listing for a specified APK and language - # code. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [Fixnum] apk_version_code - # The APK version code whose APK-specific listings should be read or modified. - # @param [String] language - # The language code (a BCP-47 language tag) of the APK-specific localized - # listing to read or modify. For example, to select Austrian German, pass "de-AT" - # . - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::ApkListing] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::ApkListing] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_apk_listing(package_name, edit_id, apk_version_code, language, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}', options) - command.response_representation = Google::Apis::AndroidpublisherV2::ApkListing::Representation - command.response_class = Google::Apis::AndroidpublisherV2::ApkListing - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['apkVersionCode'] = apk_version_code unless apk_version_code.nil? - command.params['language'] = language unless language.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Lists all the APK-specific localized listings for a specified APK. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [Fixnum] apk_version_code - # The APK version code whose APK-specific listings should be read or modified. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::ListApkListingsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::ListApkListingsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_apk_listings(package_name, edit_id, apk_version_code, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{packageName}/edits/{editId}/apks/{apkVersionCode}/listings', options) - command.response_representation = Google::Apis::AndroidpublisherV2::ListApkListingsResponse::Representation - command.response_class = Google::Apis::AndroidpublisherV2::ListApkListingsResponse - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['apkVersionCode'] = apk_version_code unless apk_version_code.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Updates or creates the APK-specific localized listing for a specified APK and - # language code. This method supports patch semantics. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [Fixnum] apk_version_code - # The APK version code whose APK-specific listings should be read or modified. - # @param [String] language - # The language code (a BCP-47 language tag) of the APK-specific localized - # listing to read or modify. For example, to select Austrian German, pass "de-AT" - # . - # @param [Google::Apis::AndroidpublisherV2::ApkListing] apk_listing_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::ApkListing] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::ApkListing] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_apk_listing(package_name, edit_id, apk_version_code, language, apk_listing_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, '{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}', options) - command.request_representation = Google::Apis::AndroidpublisherV2::ApkListing::Representation - command.request_object = apk_listing_object - command.response_representation = Google::Apis::AndroidpublisherV2::ApkListing::Representation - command.response_class = Google::Apis::AndroidpublisherV2::ApkListing - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['apkVersionCode'] = apk_version_code unless apk_version_code.nil? - command.params['language'] = language unless language.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Updates or creates the APK-specific localized listing for a specified APK and - # language code. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [Fixnum] apk_version_code - # The APK version code whose APK-specific listings should be read or modified. - # @param [String] language - # The language code (a BCP-47 language tag) of the APK-specific localized - # listing to read or modify. For example, to select Austrian German, pass "de-AT" - # . - # @param [Google::Apis::AndroidpublisherV2::ApkListing] apk_listing_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::ApkListing] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::ApkListing] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_apk_listing(package_name, edit_id, apk_version_code, language, apk_listing_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, '{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}', options) - command.request_representation = Google::Apis::AndroidpublisherV2::ApkListing::Representation - command.request_object = apk_listing_object - command.response_representation = Google::Apis::AndroidpublisherV2::ApkListing::Representation - command.response_class = Google::Apis::AndroidpublisherV2::ApkListing - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['apkVersionCode'] = apk_version_code unless apk_version_code.nil? - command.params['language'] = language unless language.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Creates a new APK without uploading the APK itself to Google Play, instead - # hosting the APK at a specified URL. This function is only available to - # enterprises using Google Play for Work whose application is configured to - # restrict distribution to the enterprise domain. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [Google::Apis::AndroidpublisherV2::ApksAddExternallyHostedRequest] apks_add_externally_hosted_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::ApksAddExternallyHostedResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::ApksAddExternallyHostedResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def add_externally_hosted_apk(package_name, edit_id, apks_add_externally_hosted_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{packageName}/edits/{editId}/apks/externallyHosted', options) - command.request_representation = Google::Apis::AndroidpublisherV2::ApksAddExternallyHostedRequest::Representation - command.request_object = apks_add_externally_hosted_request_object - command.response_representation = Google::Apis::AndroidpublisherV2::ApksAddExternallyHostedResponse::Representation - command.response_class = Google::Apis::AndroidpublisherV2::ApksAddExternallyHostedResponse - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::ListApksResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::ListApksResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_apks(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{packageName}/edits/{editId}/apks', options) - command.response_representation = Google::Apis::AndroidpublisherV2::ListApksResponse::Representation - command.response_class = Google::Apis::AndroidpublisherV2::ListApksResponse - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [IO, String] upload_source - # IO stream or filename containing content to upload - # @param [String] content_type - # Content type of the uploaded content. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::Apk] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::Apk] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def upload_apk(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) - if upload_source.nil? - command = make_simple_command(:post, '{packageName}/edits/{editId}/apks', options) - else - command = make_upload_command(:post, '{packageName}/edits/{editId}/apks', options) - command.upload_source = upload_source - command.upload_content_type = content_type - end - command.response_representation = Google::Apis::AndroidpublisherV2::Apk::Representation - command.response_class = Google::Apis::AndroidpublisherV2::Apk - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::BundlesListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::BundlesListResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_edit_bundles(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{packageName}/edits/{editId}/bundles', options) - command.response_representation = Google::Apis::AndroidpublisherV2::BundlesListResponse::Representation - command.response_class = Google::Apis::AndroidpublisherV2::BundlesListResponse - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Uploads a new Android App Bundle to this edit. If you are using the Google API - # client libraries, please increase the timeout of the http request before - # calling this endpoint (a timeout of 2 minutes is recommended). See: https:// - # developers.google.com/api-client-library/java/google-api-java-client/errors - # for an example in java. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [Boolean] ack_bundle_installation_warning - # Must be set to true if the bundle installation may trigger a warning on user - # devices (for example, if installation size may be over a threshold, typically - # 100 MB). - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [IO, String] upload_source - # IO stream or filename containing content to upload - # @param [String] content_type - # Content type of the uploaded content. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::Bundle] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::Bundle] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def upload_edit_bundle(package_name, edit_id, ack_bundle_installation_warning: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) - if upload_source.nil? - command = make_simple_command(:post, '{packageName}/edits/{editId}/bundles', options) - else - command = make_upload_command(:post, '{packageName}/edits/{editId}/bundles', options) - command.upload_source = upload_source - command.upload_content_type = content_type - end - command.response_representation = Google::Apis::AndroidpublisherV2::Bundle::Representation - command.response_class = Google::Apis::AndroidpublisherV2::Bundle - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.query['ackBundleInstallationWarning'] = ack_bundle_installation_warning unless ack_bundle_installation_warning.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Uploads the deobfuscation file of the specified APK. If a deobfuscation file - # already exists, it will be replaced. - # @param [String] package_name - # Unique identifier of the Android app for which the deobfuscatiuon files are - # being uploaded; for example, "com.spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [Fixnum] apk_version_code - # The version code of the APK whose deobfuscation file is being uploaded. - # @param [String] deobfuscation_file_type - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [IO, String] upload_source - # IO stream or filename containing content to upload - # @param [String] content_type - # Content type of the uploaded content. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::DeobfuscationFilesUploadResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::DeobfuscationFilesUploadResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def upload_edit_deobfuscationfile(package_name, edit_id, apk_version_code, deobfuscation_file_type, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) - if upload_source.nil? - command = make_simple_command(:post, '{packageName}/edits/{editId}/apks/{apkVersionCode}/deobfuscationFiles/{deobfuscationFileType}', options) - else - command = make_upload_command(:post, '{packageName}/edits/{editId}/apks/{apkVersionCode}/deobfuscationFiles/{deobfuscationFileType}', options) - command.upload_source = upload_source - command.upload_content_type = content_type - end - command.response_representation = Google::Apis::AndroidpublisherV2::DeobfuscationFilesUploadResponse::Representation - command.response_class = Google::Apis::AndroidpublisherV2::DeobfuscationFilesUploadResponse - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['apkVersionCode'] = apk_version_code unless apk_version_code.nil? - command.params['deobfuscationFileType'] = deobfuscation_file_type unless deobfuscation_file_type.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Fetches app details for this edit. This includes the default language and - # developer support contact information. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::AppDetails] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::AppDetails] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_detail(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{packageName}/edits/{editId}/details', options) - command.response_representation = Google::Apis::AndroidpublisherV2::AppDetails::Representation - command.response_class = Google::Apis::AndroidpublisherV2::AppDetails - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Updates app details for this edit. This method supports patch semantics. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [Google::Apis::AndroidpublisherV2::AppDetails] app_details_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::AppDetails] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::AppDetails] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_detail(package_name, edit_id, app_details_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, '{packageName}/edits/{editId}/details', options) - command.request_representation = Google::Apis::AndroidpublisherV2::AppDetails::Representation - command.request_object = app_details_object - command.response_representation = Google::Apis::AndroidpublisherV2::AppDetails::Representation - command.response_class = Google::Apis::AndroidpublisherV2::AppDetails - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Updates app details for this edit. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [Google::Apis::AndroidpublisherV2::AppDetails] app_details_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::AppDetails] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::AppDetails] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_detail(package_name, edit_id, app_details_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, '{packageName}/edits/{editId}/details', options) - command.request_representation = Google::Apis::AndroidpublisherV2::AppDetails::Representation - command.request_object = app_details_object - command.response_representation = Google::Apis::AndroidpublisherV2::AppDetails::Representation - command.response_class = Google::Apis::AndroidpublisherV2::AppDetails - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Fetches the Expansion File configuration for the APK specified. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [Fixnum] apk_version_code - # The version code of the APK whose Expansion File configuration is being read - # or modified. - # @param [String] expansion_file_type - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::ExpansionFile] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::ExpansionFile] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_expansion_file(package_name, edit_id, apk_version_code, expansion_file_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}', options) - command.response_representation = Google::Apis::AndroidpublisherV2::ExpansionFile::Representation - command.response_class = Google::Apis::AndroidpublisherV2::ExpansionFile - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['apkVersionCode'] = apk_version_code unless apk_version_code.nil? - command.params['expansionFileType'] = expansion_file_type unless expansion_file_type.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Updates the APK's Expansion File configuration to reference another APK's - # Expansion Files. To add a new Expansion File use the Upload method. This - # method supports patch semantics. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [Fixnum] apk_version_code - # The version code of the APK whose Expansion File configuration is being read - # or modified. - # @param [String] expansion_file_type - # @param [Google::Apis::AndroidpublisherV2::ExpansionFile] expansion_file_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::ExpansionFile] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::ExpansionFile] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_expansion_file(package_name, edit_id, apk_version_code, expansion_file_type, expansion_file_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, '{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}', options) - command.request_representation = Google::Apis::AndroidpublisherV2::ExpansionFile::Representation - command.request_object = expansion_file_object - command.response_representation = Google::Apis::AndroidpublisherV2::ExpansionFile::Representation - command.response_class = Google::Apis::AndroidpublisherV2::ExpansionFile - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['apkVersionCode'] = apk_version_code unless apk_version_code.nil? - command.params['expansionFileType'] = expansion_file_type unless expansion_file_type.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Updates the APK's Expansion File configuration to reference another APK's - # Expansion Files. To add a new Expansion File use the Upload method. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [Fixnum] apk_version_code - # The version code of the APK whose Expansion File configuration is being read - # or modified. - # @param [String] expansion_file_type - # @param [Google::Apis::AndroidpublisherV2::ExpansionFile] expansion_file_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::ExpansionFile] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::ExpansionFile] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_expansion_file(package_name, edit_id, apk_version_code, expansion_file_type, expansion_file_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, '{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}', options) - command.request_representation = Google::Apis::AndroidpublisherV2::ExpansionFile::Representation - command.request_object = expansion_file_object - command.response_representation = Google::Apis::AndroidpublisherV2::ExpansionFile::Representation - command.response_class = Google::Apis::AndroidpublisherV2::ExpansionFile - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['apkVersionCode'] = apk_version_code unless apk_version_code.nil? - command.params['expansionFileType'] = expansion_file_type unless expansion_file_type.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Uploads and attaches a new Expansion File to the APK specified. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [Fixnum] apk_version_code - # The version code of the APK whose Expansion File configuration is being read - # or modified. - # @param [String] expansion_file_type - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [IO, String] upload_source - # IO stream or filename containing content to upload - # @param [String] content_type - # Content type of the uploaded content. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::UploadExpansionFilesResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::UploadExpansionFilesResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def upload_expansion_file(package_name, edit_id, apk_version_code, expansion_file_type, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) - if upload_source.nil? - command = make_simple_command(:post, '{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}', options) - else - command = make_upload_command(:post, '{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}', options) - command.upload_source = upload_source - command.upload_content_type = content_type - end - command.response_representation = Google::Apis::AndroidpublisherV2::UploadExpansionFilesResponse::Representation - command.response_class = Google::Apis::AndroidpublisherV2::UploadExpansionFilesResponse - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['apkVersionCode'] = apk_version_code unless apk_version_code.nil? - command.params['expansionFileType'] = expansion_file_type unless expansion_file_type.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Deletes the image (specified by id) from the edit. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] language - # The language code (a BCP-47 language tag) of the localized listing whose - # images are to read or modified. For example, to select Austrian German, pass " - # de-AT". - # @param [String] image_type - # @param [String] image_id - # Unique identifier an image within the set of images attached to this edit. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_image(package_name, edit_id, language, image_type, image_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, '{packageName}/edits/{editId}/listings/{language}/{imageType}/{imageId}', options) - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['language'] = language unless language.nil? - command.params['imageType'] = image_type unless image_type.nil? - command.params['imageId'] = image_id unless image_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Deletes all images for the specified language and image type. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] language - # The language code (a BCP-47 language tag) of the localized listing whose - # images are to read or modified. For example, to select Austrian German, pass " - # de-AT". - # @param [String] image_type - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::DeleteAllImagesResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::DeleteAllImagesResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_all_images(package_name, edit_id, language, image_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, '{packageName}/edits/{editId}/listings/{language}/{imageType}', options) - command.response_representation = Google::Apis::AndroidpublisherV2::DeleteAllImagesResponse::Representation - command.response_class = Google::Apis::AndroidpublisherV2::DeleteAllImagesResponse - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['language'] = language unless language.nil? - command.params['imageType'] = image_type unless image_type.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Lists all images for the specified language and image type. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] language - # The language code (a BCP-47 language tag) of the localized listing whose - # images are to read or modified. For example, to select Austrian German, pass " - # de-AT". - # @param [String] image_type - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::ListImagesResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::ListImagesResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_images(package_name, edit_id, language, image_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{packageName}/edits/{editId}/listings/{language}/{imageType}', options) - command.response_representation = Google::Apis::AndroidpublisherV2::ListImagesResponse::Representation - command.response_class = Google::Apis::AndroidpublisherV2::ListImagesResponse - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['language'] = language unless language.nil? - command.params['imageType'] = image_type unless image_type.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Uploads a new image and adds it to the list of images for the specified - # language and image type. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] language - # The language code (a BCP-47 language tag) of the localized listing whose - # images are to read or modified. For example, to select Austrian German, pass " - # de-AT". - # @param [String] image_type - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [IO, String] upload_source - # IO stream or filename containing content to upload - # @param [String] content_type - # Content type of the uploaded content. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::UploadImagesResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::UploadImagesResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def upload_image(package_name, edit_id, language, image_type, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) - if upload_source.nil? - command = make_simple_command(:post, '{packageName}/edits/{editId}/listings/{language}/{imageType}', options) - else - command = make_upload_command(:post, '{packageName}/edits/{editId}/listings/{language}/{imageType}', options) - command.upload_source = upload_source - command.upload_content_type = content_type - end - command.response_representation = Google::Apis::AndroidpublisherV2::UploadImagesResponse::Representation - command.response_class = Google::Apis::AndroidpublisherV2::UploadImagesResponse - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['language'] = language unless language.nil? - command.params['imageType'] = image_type unless image_type.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Deletes the specified localized store listing from an edit. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] language - # The language code (a BCP-47 language tag) of the localized listing to read or - # modify. For example, to select Austrian German, pass "de-AT". - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_listing(package_name, edit_id, language, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, '{packageName}/edits/{editId}/listings/{language}', options) - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['language'] = language unless language.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Deletes all localized listings from an edit. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_all_listings(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, '{packageName}/edits/{editId}/listings', options) - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Fetches information about a localized store listing. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] language - # The language code (a BCP-47 language tag) of the localized listing to read or - # modify. For example, to select Austrian German, pass "de-AT". - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::Listing] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::Listing] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_listing(package_name, edit_id, language, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{packageName}/edits/{editId}/listings/{language}', options) - command.response_representation = Google::Apis::AndroidpublisherV2::Listing::Representation - command.response_class = Google::Apis::AndroidpublisherV2::Listing - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['language'] = language unless language.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Returns all of the localized store listings attached to this edit. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::ListListingsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::ListListingsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_listings(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{packageName}/edits/{editId}/listings', options) - command.response_representation = Google::Apis::AndroidpublisherV2::ListListingsResponse::Representation - command.response_class = Google::Apis::AndroidpublisherV2::ListListingsResponse - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Creates or updates a localized store listing. This method supports patch - # semantics. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] language - # The language code (a BCP-47 language tag) of the localized listing to read or - # modify. For example, to select Austrian German, pass "de-AT". - # @param [Google::Apis::AndroidpublisherV2::Listing] listing_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::Listing] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::Listing] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_listing(package_name, edit_id, language, listing_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, '{packageName}/edits/{editId}/listings/{language}', options) - command.request_representation = Google::Apis::AndroidpublisherV2::Listing::Representation - command.request_object = listing_object - command.response_representation = Google::Apis::AndroidpublisherV2::Listing::Representation - command.response_class = Google::Apis::AndroidpublisherV2::Listing - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['language'] = language unless language.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Creates or updates a localized store listing. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] language - # The language code (a BCP-47 language tag) of the localized listing to read or - # modify. For example, to select Austrian German, pass "de-AT". - # @param [Google::Apis::AndroidpublisherV2::Listing] listing_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::Listing] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::Listing] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_listing(package_name, edit_id, language, listing_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, '{packageName}/edits/{editId}/listings/{language}', options) - command.request_representation = Google::Apis::AndroidpublisherV2::Listing::Representation - command.request_object = listing_object - command.response_representation = Google::Apis::AndroidpublisherV2::Listing::Representation - command.response_class = Google::Apis::AndroidpublisherV2::Listing - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['language'] = language unless language.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] track - # The track to read or modify. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::Testers] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::Testers] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_tester(package_name, edit_id, track, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{packageName}/edits/{editId}/testers/{track}', options) - command.response_representation = Google::Apis::AndroidpublisherV2::Testers::Representation - command.response_class = Google::Apis::AndroidpublisherV2::Testers - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['track'] = track unless track.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] track - # The track to read or modify. - # @param [Google::Apis::AndroidpublisherV2::Testers] testers_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::Testers] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::Testers] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_tester(package_name, edit_id, track, testers_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, '{packageName}/edits/{editId}/testers/{track}', options) - command.request_representation = Google::Apis::AndroidpublisherV2::Testers::Representation - command.request_object = testers_object - command.response_representation = Google::Apis::AndroidpublisherV2::Testers::Representation - command.response_class = Google::Apis::AndroidpublisherV2::Testers - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['track'] = track unless track.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] track - # The track to read or modify. - # @param [Google::Apis::AndroidpublisherV2::Testers] testers_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::Testers] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::Testers] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_tester(package_name, edit_id, track, testers_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, '{packageName}/edits/{editId}/testers/{track}', options) - command.request_representation = Google::Apis::AndroidpublisherV2::Testers::Representation - command.request_object = testers_object - command.response_representation = Google::Apis::AndroidpublisherV2::Testers::Representation - command.response_class = Google::Apis::AndroidpublisherV2::Testers - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['track'] = track unless track.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Fetches the track configuration for the specified track type. Includes the APK - # version codes that are in this track. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] track - # The track to read or modify. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::Track] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::Track] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_track(package_name, edit_id, track, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{packageName}/edits/{editId}/tracks/{track}', options) - command.response_representation = Google::Apis::AndroidpublisherV2::Track::Representation - command.response_class = Google::Apis::AndroidpublisherV2::Track - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['track'] = track unless track.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Lists all the track configurations for this edit. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::ListTracksResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::ListTracksResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_tracks(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{packageName}/edits/{editId}/tracks', options) - command.response_representation = Google::Apis::AndroidpublisherV2::ListTracksResponse::Representation - command.response_class = Google::Apis::AndroidpublisherV2::ListTracksResponse - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Updates the track configuration for the specified track type. This method - # supports patch semantics. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] track - # The track to read or modify. - # @param [Google::Apis::AndroidpublisherV2::Track] track_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::Track] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::Track] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_track(package_name, edit_id, track, track_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, '{packageName}/edits/{editId}/tracks/{track}', options) - command.request_representation = Google::Apis::AndroidpublisherV2::Track::Representation - command.request_object = track_object - command.response_representation = Google::Apis::AndroidpublisherV2::Track::Representation - command.response_class = Google::Apis::AndroidpublisherV2::Track - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['track'] = track unless track.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Updates the track configuration for the specified track type. - # @param [String] package_name - # Unique identifier for the Android app that is being updated; for example, "com. - # spiffygame". - # @param [String] edit_id - # Unique identifier for this edit. - # @param [String] track - # The track to read or modify. - # @param [Google::Apis::AndroidpublisherV2::Track] track_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::Track] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::Track] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_track(package_name, edit_id, track, track_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, '{packageName}/edits/{editId}/tracks/{track}', options) - command.request_representation = Google::Apis::AndroidpublisherV2::Track::Representation - command.request_object = track_object - command.response_representation = Google::Apis::AndroidpublisherV2::Track::Representation - command.response_class = Google::Apis::AndroidpublisherV2::Track - command.params['packageName'] = package_name unless package_name.nil? - command.params['editId'] = edit_id unless edit_id.nil? - command.params['track'] = track unless track.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Delete an in-app product for an app. - # @param [String] package_name - # Unique identifier for the Android app with the in-app product; for example, " - # com.spiffygame". - # @param [String] sku - # Unique identifier for the in-app product. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_in_app_product(package_name, sku, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, '{packageName}/inappproducts/{sku}', options) - command.params['packageName'] = package_name unless package_name.nil? - command.params['sku'] = sku unless sku.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Returns information about the in-app product specified. - # @param [String] package_name - # @param [String] sku - # Unique identifier for the in-app product. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::InAppProduct] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::InAppProduct] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_in_app_product(package_name, sku, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{packageName}/inappproducts/{sku}', options) - command.response_representation = Google::Apis::AndroidpublisherV2::InAppProduct::Representation - command.response_class = Google::Apis::AndroidpublisherV2::InAppProduct - command.params['packageName'] = package_name unless package_name.nil? - command.params['sku'] = sku unless sku.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Creates a new in-app product for an app. - # @param [String] package_name - # Unique identifier for the Android app; for example, "com.spiffygame". - # @param [Google::Apis::AndroidpublisherV2::InAppProduct] in_app_product_object - # @param [Boolean] auto_convert_missing_prices - # If true the prices for all regions targeted by the parent app that don't have - # a price specified for this in-app product will be auto converted to the target - # currency based on the default price. Defaults to false. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::InAppProduct] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::InAppProduct] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_in_app_product(package_name, in_app_product_object = nil, auto_convert_missing_prices: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{packageName}/inappproducts', options) - command.request_representation = Google::Apis::AndroidpublisherV2::InAppProduct::Representation - command.request_object = in_app_product_object - command.response_representation = Google::Apis::AndroidpublisherV2::InAppProduct::Representation - command.response_class = Google::Apis::AndroidpublisherV2::InAppProduct - command.params['packageName'] = package_name unless package_name.nil? - command.query['autoConvertMissingPrices'] = auto_convert_missing_prices unless auto_convert_missing_prices.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # List all the in-app products for an Android app, both subscriptions and - # managed in-app products.. - # @param [String] package_name - # Unique identifier for the Android app with in-app products; for example, "com. - # spiffygame". - # @param [Fixnum] max_results - # @param [Fixnum] start_index - # @param [String] token - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::ListInAppProductsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::ListInAppProductsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_in_app_products(package_name, max_results: nil, start_index: nil, token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{packageName}/inappproducts', options) - command.response_representation = Google::Apis::AndroidpublisherV2::ListInAppProductsResponse::Representation - command.response_class = Google::Apis::AndroidpublisherV2::ListInAppProductsResponse - command.params['packageName'] = package_name unless package_name.nil? - command.query['maxResults'] = max_results unless max_results.nil? - command.query['startIndex'] = start_index unless start_index.nil? - command.query['token'] = token unless token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Updates the details of an in-app product. This method supports patch semantics. - # @param [String] package_name - # Unique identifier for the Android app with the in-app product; for example, " - # com.spiffygame". - # @param [String] sku - # Unique identifier for the in-app product. - # @param [Google::Apis::AndroidpublisherV2::InAppProduct] in_app_product_object - # @param [Boolean] auto_convert_missing_prices - # If true the prices for all regions targeted by the parent app that don't have - # a price specified for this in-app product will be auto converted to the target - # currency based on the default price. Defaults to false. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::InAppProduct] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::InAppProduct] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_in_app_product(package_name, sku, in_app_product_object = nil, auto_convert_missing_prices: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, '{packageName}/inappproducts/{sku}', options) - command.request_representation = Google::Apis::AndroidpublisherV2::InAppProduct::Representation - command.request_object = in_app_product_object - command.response_representation = Google::Apis::AndroidpublisherV2::InAppProduct::Representation - command.response_class = Google::Apis::AndroidpublisherV2::InAppProduct - command.params['packageName'] = package_name unless package_name.nil? - command.params['sku'] = sku unless sku.nil? - command.query['autoConvertMissingPrices'] = auto_convert_missing_prices unless auto_convert_missing_prices.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Updates the details of an in-app product. - # @param [String] package_name - # Unique identifier for the Android app with the in-app product; for example, " - # com.spiffygame". - # @param [String] sku - # Unique identifier for the in-app product. - # @param [Google::Apis::AndroidpublisherV2::InAppProduct] in_app_product_object - # @param [Boolean] auto_convert_missing_prices - # If true the prices for all regions targeted by the parent app that don't have - # a price specified for this in-app product will be auto converted to the target - # currency based on the default price. Defaults to false. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::InAppProduct] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::InAppProduct] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_in_app_product(package_name, sku, in_app_product_object = nil, auto_convert_missing_prices: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, '{packageName}/inappproducts/{sku}', options) - command.request_representation = Google::Apis::AndroidpublisherV2::InAppProduct::Representation - command.request_object = in_app_product_object - command.response_representation = Google::Apis::AndroidpublisherV2::InAppProduct::Representation - command.response_class = Google::Apis::AndroidpublisherV2::InAppProduct - command.params['packageName'] = package_name unless package_name.nil? - command.params['sku'] = sku unless sku.nil? - command.query['autoConvertMissingPrices'] = auto_convert_missing_prices unless auto_convert_missing_prices.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Refund a user's subscription or in-app purchase order. - # @param [String] package_name - # The package name of the application for which this subscription or in-app item - # was purchased (for example, 'com.some.thing'). - # @param [String] order_id - # The order ID provided to the user when the subscription or in-app order was - # purchased. - # @param [Boolean] revoke - # Whether to revoke the purchased item. If set to true, access to the - # subscription or in-app item will be terminated immediately. If the item is a - # recurring subscription, all future payments will also be terminated. Consumed - # in-app items need to be handled by developer's app. (optional) - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def refund_order(package_name, order_id, revoke: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{packageName}/orders/{orderId}:refund', options) - command.params['packageName'] = package_name unless package_name.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['revoke'] = revoke unless revoke.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - # Checks the purchase and consumption status of an inapp item. # @param [String] package_name # The package name of the application the inapp product was sold in (for example, @@ -2130,207 +91,6 @@ module Google execute_or_queue_command(command, &block) end - # Cancels a user's subscription purchase. The subscription remains valid until - # its expiration time. - # @param [String] package_name - # The package name of the application for which this subscription was purchased ( - # for example, 'com.some.thing'). - # @param [String] subscription_id - # The purchased subscription ID (for example, 'monthly001'). - # @param [String] token - # The token provided to the user's device when the subscription was purchased. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def cancel_purchase_subscription(package_name, subscription_id, token, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:cancel', options) - command.params['packageName'] = package_name unless package_name.nil? - command.params['subscriptionId'] = subscription_id unless subscription_id.nil? - command.params['token'] = token unless token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Defers a user's subscription purchase until a specified future expiration time. - # @param [String] package_name - # The package name of the application for which this subscription was purchased ( - # for example, 'com.some.thing'). - # @param [String] subscription_id - # The purchased subscription ID (for example, 'monthly001'). - # @param [String] token - # The token provided to the user's device when the subscription was purchased. - # @param [Google::Apis::AndroidpublisherV2::DeferSubscriptionPurchasesRequest] defer_subscription_purchases_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::DeferSubscriptionPurchasesResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::DeferSubscriptionPurchasesResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def defer_purchase_subscription(package_name, subscription_id, token, defer_subscription_purchases_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:defer', options) - command.request_representation = Google::Apis::AndroidpublisherV2::DeferSubscriptionPurchasesRequest::Representation - command.request_object = defer_subscription_purchases_request_object - command.response_representation = Google::Apis::AndroidpublisherV2::DeferSubscriptionPurchasesResponse::Representation - command.response_class = Google::Apis::AndroidpublisherV2::DeferSubscriptionPurchasesResponse - command.params['packageName'] = package_name unless package_name.nil? - command.params['subscriptionId'] = subscription_id unless subscription_id.nil? - command.params['token'] = token unless token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Checks whether a user's subscription purchase is valid and returns its expiry - # time. - # @param [String] package_name - # The package name of the application for which this subscription was purchased ( - # for example, 'com.some.thing'). - # @param [String] subscription_id - # The purchased subscription ID (for example, 'monthly001'). - # @param [String] token - # The token provided to the user's device when the subscription was purchased. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::SubscriptionPurchase] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::SubscriptionPurchase] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_purchase_subscription(package_name, subscription_id, token, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}', options) - command.response_representation = Google::Apis::AndroidpublisherV2::SubscriptionPurchase::Representation - command.response_class = Google::Apis::AndroidpublisherV2::SubscriptionPurchase - command.params['packageName'] = package_name unless package_name.nil? - command.params['subscriptionId'] = subscription_id unless subscription_id.nil? - command.params['token'] = token unless token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Refunds a user's subscription purchase, but the subscription remains valid - # until its expiration time and it will continue to recur. - # @param [String] package_name - # The package name of the application for which this subscription was purchased ( - # for example, 'com.some.thing'). - # @param [String] subscription_id - # The purchased subscription ID (for example, 'monthly001'). - # @param [String] token - # The token provided to the user's device when the subscription was purchased. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def refund_purchase_subscription(package_name, subscription_id, token, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:refund', options) - command.params['packageName'] = package_name unless package_name.nil? - command.params['subscriptionId'] = subscription_id unless subscription_id.nil? - command.params['token'] = token unless token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Refunds and immediately revokes a user's subscription purchase. Access to the - # subscription will be terminated immediately and it will stop recurring. - # @param [String] package_name - # The package name of the application for which this subscription was purchased ( - # for example, 'com.some.thing'). - # @param [String] subscription_id - # The purchased subscription ID (for example, 'monthly001'). - # @param [String] token - # The token provided to the user's device when the subscription was purchased. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def revoke_purchase_subscription(package_name, subscription_id, token, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:revoke', options) - command.params['packageName'] = package_name unless package_name.nil? - command.params['subscriptionId'] = subscription_id unless subscription_id.nil? - command.params['token'] = token unless token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - # Lists the purchases that were canceled, refunded or charged-back. # @param [String] package_name # The package name of the application for which voided purchases need to be @@ -2386,125 +146,6 @@ module Google command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - - # Returns a single review. - # @param [String] package_name - # Unique identifier for the Android app for which we want reviews; for example, " - # com.spiffygame". - # @param [String] review_id - # @param [String] translation_language - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::Review] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::Review] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_review(package_name, review_id, translation_language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{packageName}/reviews/{reviewId}', options) - command.response_representation = Google::Apis::AndroidpublisherV2::Review::Representation - command.response_class = Google::Apis::AndroidpublisherV2::Review - command.params['packageName'] = package_name unless package_name.nil? - command.params['reviewId'] = review_id unless review_id.nil? - command.query['translationLanguage'] = translation_language unless translation_language.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Returns a list of reviews. Only reviews from last week will be returned. - # @param [String] package_name - # Unique identifier for the Android app for which we want reviews; for example, " - # com.spiffygame". - # @param [Fixnum] max_results - # @param [Fixnum] start_index - # @param [String] token - # @param [String] translation_language - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::ReviewsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::ReviewsListResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_reviews(package_name, max_results: nil, start_index: nil, token: nil, translation_language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{packageName}/reviews', options) - command.response_representation = Google::Apis::AndroidpublisherV2::ReviewsListResponse::Representation - command.response_class = Google::Apis::AndroidpublisherV2::ReviewsListResponse - command.params['packageName'] = package_name unless package_name.nil? - command.query['maxResults'] = max_results unless max_results.nil? - command.query['startIndex'] = start_index unless start_index.nil? - command.query['token'] = token unless token.nil? - command.query['translationLanguage'] = translation_language unless translation_language.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Reply to a single review, or update an existing reply. - # @param [String] package_name - # Unique identifier for the Android app for which we want reviews; for example, " - # com.spiffygame". - # @param [String] review_id - # @param [Google::Apis::AndroidpublisherV2::ReviewsReplyRequest] reviews_reply_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::ReviewsReplyResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::ReviewsReplyResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def reply_review(package_name, review_id, reviews_reply_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{packageName}/reviews/{reviewId}:reply', options) - command.request_representation = Google::Apis::AndroidpublisherV2::ReviewsReplyRequest::Representation - command.request_object = reviews_reply_request_object - command.response_representation = Google::Apis::AndroidpublisherV2::ReviewsReplyResponse::Representation - command.response_class = Google::Apis::AndroidpublisherV2::ReviewsReplyResponse - command.params['packageName'] = package_name unless package_name.nil? - command.params['reviewId'] = review_id unless review_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end protected diff --git a/generated/google/apis/androidpublisher_v3.rb b/generated/google/apis/androidpublisher_v3.rb index 6e9b015d1..0c2c62410 100644 --- a/generated/google/apis/androidpublisher_v3.rb +++ b/generated/google/apis/androidpublisher_v3.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/android-publisher module AndroidpublisherV3 VERSION = 'V3' - REVISION = '20200331' + REVISION = '20200421' # View and manage your Google Play Developer account AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher' diff --git a/generated/google/apis/androidpublisher_v3/classes.rb b/generated/google/apis/androidpublisher_v3/classes.rb index ef6587271..5c212ee53 100644 --- a/generated/google/apis/androidpublisher_v3/classes.rb +++ b/generated/google/apis/androidpublisher_v3/classes.rb @@ -2088,8 +2088,9 @@ module Google # In-app update priority of the release. All newly added APKs in the release # will be considered at this priority. in_app_update_priority can take values - # between [0, 5]. 5 is the highest priority. Default priority is 0. See https:// - # developer.android.com/guide/playcore/in-app-updates. + # between [0, 5]. 5 is the highest priority. Default priority is 0. + # in_app_update_priority can not be updated once the release is rolled out. See + # https://developer.android.com/guide/playcore/in-app-updates. # Corresponds to the JSON property `inAppUpdatePriority` # @return [Fixnum] attr_accessor :in_app_update_priority diff --git a/generated/google/apis/androidpublisher_v3/service.rb b/generated/google/apis/androidpublisher_v3/service.rb index f20f9054e..3034df257 100644 --- a/generated/google/apis/androidpublisher_v3/service.rb +++ b/generated/google/apis/androidpublisher_v3/service.rb @@ -458,10 +458,11 @@ module Google execute_or_queue_command(command, &block) end - # Uploads the deobfuscation file of the specified APK. If a deobfuscation file - # already exists, it will be replaced. + # Uploads the deobfuscation file of the specified APK. If a deobfuscation or + # symbolication file already exists, it will be replaced. See https://developer. + # android.com/studio/build/shrink-code to learn more about deobfuscation files. # @param [String] package_name - # Unique identifier of the Android app for which the deobfuscatiuon files are + # Unique identifier of the Android app for which the deobfuscation files are # being uploaded; for example, "com.spiffygame". # @param [String] edit_id # Unique identifier for this edit. diff --git a/generated/google/apis/apigee_v1.rb b/generated/google/apis/apigee_v1.rb new file mode 100644 index 000000000..b1855dbb2 --- /dev/null +++ b/generated/google/apis/apigee_v1.rb @@ -0,0 +1,40 @@ +# 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 'google/apis/apigee_v1/service.rb' +require 'google/apis/apigee_v1/classes.rb' +require 'google/apis/apigee_v1/representations.rb' + +module Google + module Apis + # Apigee API + # + # The Apigee API lets you programmatically manage Apigee hybrid with a set of + # RESTful operations, including:
  • Create, edit, and delete API proxies
  • Manage users
  • Deploy and undeploy proxy revisions
  • + # Configure environments

For information on using the APIs described + # in this section, see + # Get started using the APIs.

Note: This product is + # available as a free trial for a time period of 60 days. + # + # @see https://cloud.google.com/apigee-api-management/ + module ApigeeV1 + VERSION = 'V1' + REVISION = '20200502' + + # View and manage your data across Google Cloud Platform services + AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' + end + end +end diff --git a/generated/google/apis/apigee_v1/classes.rb b/generated/google/apis/apigee_v1/classes.rb new file mode 100644 index 000000000..a2f3f001f --- /dev/null +++ b/generated/google/apis/apigee_v1/classes.rb @@ -0,0 +1,5205 @@ +# 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 ApigeeV1 + + # Message that represents an arbitrary HTTP body. It should only be used for + # payload formats that can't be represented as JSON, such as raw binary or + # an HTML page. + # This message can be used both in streaming and non-streaming API methods in + # the request as well as the response. + # It can be used as a top-level request field, which is convenient if one + # wants to extract parameters from either the URL or HTTP template into the + # request fields and also want access to the raw HTTP body. + # Example: + # message GetResourceRequest ` + # // A unique request id. + # string request_id = 1; + # // The raw HTTP body is bound to this field. + # google.api.HttpBody http_body = 2; + # ` + # service ResourceService ` + # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); + # rpc UpdateResource(google.api.HttpBody) returns + # (google.protobuf.Empty); + # ` + # Example with streaming methods: + # service CaldavService ` + # rpc GetCalendar(stream google.api.HttpBody) + # returns (stream google.api.HttpBody); + # rpc UpdateCalendar(stream google.api.HttpBody) + # returns (stream google.api.HttpBody); + # ` + # Use of this type only changes how the request and response bodies are + # handled, all other features will continue to work unchanged. + class GoogleApiHttpBody + include Google::Apis::Core::Hashable + + # The HTTP Content-Type header value specifying the content type of the body. + # Corresponds to the JSON property `contentType` + # @return [String] + attr_accessor :content_type + + # The HTTP request/response body as raw binary. + # Corresponds to the JSON property `data` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :data + + # Application specific response metadata. Must be set in the first response + # for streaming APIs. + # Corresponds to the JSON property `extensions` + # @return [Array>] + attr_accessor :extensions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content_type = args[:content_type] if args.key?(:content_type) + @data = args[:data] if args.key?(:data) + @extensions = args[:extensions] if args.key?(:extensions) + end + end + + # + class GoogleCloudApigeeV1Access + include Google::Apis::Core::Hashable + + # Get action. For example, + # "Get" : ` + # "name" : "target.name", + # "value" : "default" + # ` + # Corresponds to the JSON property `Get` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AccessGet] + attr_accessor :get + + # Remove action. For example, + # "Remove" : ` + # "name" : "target.name", + # "success" : true + # ` + # Corresponds to the JSON property `Remove` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AccessRemove] + attr_accessor :remove + + # Set action. For example, + # "Set" : ` + # "name" : "target.name", + # "success" : true, + # "value" : "default" + # ` + # Corresponds to the JSON property `Set` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AccessSet] + attr_accessor :set + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @get = args[:get] if args.key?(:get) + @remove = args[:remove] if args.key?(:remove) + @set = args[:set] if args.key?(:set) + end + end + + # Get action. For example, + # "Get" : ` + # "name" : "target.name", + # "value" : "default" + # ` + class GoogleCloudApigeeV1AccessGet + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @value = args[:value] if args.key?(:value) + end + end + + # Remove action. For example, + # "Remove" : ` + # "name" : "target.name", + # "success" : true + # ` + class GoogleCloudApigeeV1AccessRemove + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # + # Corresponds to the JSON property `success` + # @return [Boolean] + attr_accessor :success + alias_method :success?, :success + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @success = args[:success] if args.key?(:success) + end + end + + # Set action. For example, + # "Set" : ` + # "name" : "target.name", + # "success" : true, + # "value" : "default" + # ` + class GoogleCloudApigeeV1AccessSet + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # + # Corresponds to the JSON property `success` + # @return [Boolean] + attr_accessor :success + alias_method :success?, :success + + # + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @success = args[:success] if args.key?(:success) + @value = args[:value] if args.key?(:value) + end + end + + # A reference to a certificate or key, certificate pair. + class GoogleCloudApigeeV1Alias + include Google::Apis::Core::Hashable + + # The resource ID for this alias. Values must match regular expression + # `[^/]`1,255``. + # Corresponds to the JSON property `alias` + # @return [String] + attr_accessor :alias + + # The chain of certificates under this alias. + # Corresponds to the JSON property `certsInfo` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Certificate] + attr_accessor :certs_info + + # The type of alias. + # 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) + @alias = args[:alias] if args.key?(:alias) + @certs_info = args[:certs_info] if args.key?(:certs_info) + @type = args[:type] if args.key?(:type) + end + end + + # + class GoogleCloudApigeeV1AliasRevisionConfig + include Google::Apis::Core::Hashable + + # The location of the alias file, e.g. a GCS URI. + # Corresponds to the JSON property `location` + # @return [String] + attr_accessor :location + + # The name of the alias revision included in the keystore. Must be of the + # form: + # 'organizations/`org`/environments/`env`/keystores/`keystore`/aliases/`alias`/ + # revisions/`rev`'. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # + # 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) + @location = args[:location] if args.key?(:location) + @name = args[:name] if args.key?(:name) + @type = args[:type] if args.key?(:type) + end + end + + # + class GoogleCloudApigeeV1ApiProduct + include Google::Apis::Core::Hashable + + # Comma-separated list of API resources to be bundled in the API Product. + # By default, the resource paths are mapped from the `proxy.pathsuffix` + # variable. + # The proxy path suffix is defined as the URI fragment following the + # ProxyEndpoint base path. + # For example, if the `apiResources` element is defined to be + # `/forecastrss` and the base path defined for the API proxy is + # `/weather`, then only requests to `/weather/forecastrss` are permitted by + # the API product. + # You can select a specific path, or you can select all subpaths with the + # following wildcard: + # - /**: Indicates that all sub-URIs are included. + # - /* : Indicates that only URIs one level down are included. + # By default, / supports the same resources as /** as well as the base path + # defined by the API proxy. + # For example, if the base path of the API proxy is `/v1/weatherapikey`, + # then the API product supports requests to `/v1/weatherapikey` and to any + # sub-URIs, such as `/v1/weatherapikey/forecastrss`, + # `/v1/weatherapikey/region/CA`, and so on. + # For more information, see: + # - Manage API + # products + # - Managing + # a transaction recording policy using the API + # Corresponds to the JSON property `apiResources` + # @return [Array] + attr_accessor :api_resources + + # Specifies how API keys are approved to access the APIs defined by the API + # product. + # If set to `manual`, the consumer key is generated and returned in "pending" + # state. In this case, the API keys won't work until they have been + # explicitly approved. + # If set to `auto`, the consumer key is generated and returned in "approved" + # state and can be used immediately. + #

+ # Corresponds to the JSON property `approvalType` + # @return [String] + attr_accessor :approval_type + + # Array of attributes that may be used to extend the default API product + # profile with customer-specific metadata. You can specify a maximum of 18 + # attributes. + # Use this property to specify the access level of the API product as either + # `public`, `private`, or `internal`. + # Only products marked `public` are available to developers in the Apigee + # developer portal. For example, you can set a product to `internal` while it + # is in development and then change access to `public` when it is ready to + # release on the portal. + # API products marked as `private` do not appear on the portal but + # can be accessed by external developers. + # For monetization, you can use the attributes field to: + # - Specify transaction success criteria + # - Specify custom attributes on which you base rate plan + # charges. + # Corresponds to the JSON property `attributes` + # @return [Array] + attr_accessor :attributes + + # Response only. Creation time of this environment as milliseconds since + # epoch. + # Corresponds to the JSON property `createdAt` + # @return [Fixnum] + attr_accessor :created_at + + # An overview of the API product. Include key information about the API + # product that is not captured by other fields. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The name to be displayed in the UI or developer portal to developers + # registering for API access. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # A comma-separated list of environment names to which the API product is + # bound. Requests to environments that are not listed are rejected. + # By specifying one or more environments, you can bind the resources listed + # in the API product to a specific environment, preventing developers from + # accessing those resources through API proxies deployed in another + # environment. + # This setting is used, for example, to prevent resources associated with + # API proxies in 'prod' from being accessed by API proxies deployed in + # 'test'. + # Corresponds to the JSON property `environments` + # @return [Array] + attr_accessor :environments + + # Response only. Modified time of this environment as milliseconds since + # epoch. + # Corresponds to the JSON property `lastModifiedAt` + # @return [Fixnum] + attr_accessor :last_modified_at + + # The internal name of the API Product. Characters you can use in the name + # are restricted to: A-Z0-9._\-$ %. + # + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # A comma-separated list of API proxy names to which this API product is + # bound. By specifying API proxies, you can associate resources in the API + # product with specific API proxies, preventing developers from accessing + # those resources through other API proxies. + # Edge rejects requests to API proxies that are not listed. + # + # Corresponds to the JSON property `proxies` + # @return [Array] + attr_accessor :proxies + + # The number of request messages permitted per app by this API product for + # the specified `quotaInterval` and `quotaTimeUnit`. + # For example, a `quota` of 50, for a `quotaInterval` of 12 and a + # `quotaTimeUnit` of hours means 50 requests are allowed every 12 hours. + # Corresponds to the JSON property `quota` + # @return [String] + attr_accessor :quota + + # The time interval over which the number of request messages is calculated. + # Corresponds to the JSON property `quotaInterval` + # @return [String] + attr_accessor :quota_interval + + # The time unit defined for the `quotaInterval`. Valid values include minute, + # hour, day, or month. + # Corresponds to the JSON property `quotaTimeUnit` + # @return [String] + attr_accessor :quota_time_unit + + # A comma-separated list of OAuth scopes that are validated at runtime. + # Edge validates that the scopes in any access token presented match the + # scopes defined in the OAuth policy assoicated with the API product. + # Corresponds to the JSON property `scopes` + # @return [Array] + attr_accessor :scopes + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @api_resources = args[:api_resources] if args.key?(:api_resources) + @approval_type = args[:approval_type] if args.key?(:approval_type) + @attributes = args[:attributes] if args.key?(:attributes) + @created_at = args[:created_at] if args.key?(:created_at) + @description = args[:description] if args.key?(:description) + @display_name = args[:display_name] if args.key?(:display_name) + @environments = args[:environments] if args.key?(:environments) + @last_modified_at = args[:last_modified_at] if args.key?(:last_modified_at) + @name = args[:name] if args.key?(:name) + @proxies = args[:proxies] if args.key?(:proxies) + @quota = args[:quota] if args.key?(:quota) + @quota_interval = args[:quota_interval] if args.key?(:quota_interval) + @quota_time_unit = args[:quota_time_unit] if args.key?(:quota_time_unit) + @scopes = args[:scopes] if args.key?(:scopes) + end + end + + # + class GoogleCloudApigeeV1ApiProductRef + include Google::Apis::Core::Hashable + + # Name of the API product. + # Corresponds to the JSON property `apiproduct` + # @return [String] + attr_accessor :apiproduct + + # Status of the API product. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @apiproduct = args[:apiproduct] if args.key?(:apiproduct) + @status = args[:status] if args.key?(:status) + end + end + + # Metadata describing the API proxy + class GoogleCloudApigeeV1ApiProxy + include Google::Apis::Core::Hashable + + # The id of the most recently created revision for this api proxy. + # Corresponds to the JSON property `latestRevisionId` + # @return [String] + attr_accessor :latest_revision_id + + # Metadata common to many entities in this API. + # Corresponds to the JSON property `metaData` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1EntityMetadata] + attr_accessor :meta_data + + # Name of the API proxy. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # List of revisons defined for the API proxy. + # Corresponds to the JSON property `revision` + # @return [Array] + attr_accessor :revision + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @latest_revision_id = args[:latest_revision_id] if args.key?(:latest_revision_id) + @meta_data = args[:meta_data] if args.key?(:meta_data) + @name = args[:name] if args.key?(:name) + @revision = args[:revision] if args.key?(:revision) + end + end + + # API proxy revision. + class GoogleCloudApigeeV1ApiProxyRevision + include Google::Apis::Core::Hashable + + # Base URL of the API proxy. + # Corresponds to the JSON property `basepaths` + # @return [Array] + attr_accessor :basepaths + + # Version of the API proxy configuration schema. Currently, only 4.0 is + # supported. + # Corresponds to the JSON property `configurationVersion` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ConfigVersion] + attr_accessor :configuration_version + + # Revision number, app name, and organization for the API proxy. + # Corresponds to the JSON property `contextInfo` + # @return [String] + attr_accessor :context_info + + # Time that the API proxy revision was created in milliseconds since + # epoch. + # Corresponds to the JSON property `createdAt` + # @return [Fixnum] + attr_accessor :created_at + + # Description of the API proxy revision. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Human-readable name of the API proxy. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Metadata describing the API proxy revision as a key-value map. + # Corresponds to the JSON property `entityMetaDataAsProperties` + # @return [Hash] + attr_accessor :entity_meta_data_as_properties + + # Time that the API proxy revision was last modified in + # milliseconds since epoch. + # Corresponds to the JSON property `lastModifiedAt` + # @return [Fixnum] + attr_accessor :last_modified_at + + # Name of the API proxy. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # List of policy names included in the API proxy revision.. + # Corresponds to the JSON property `policies` + # @return [Array] + attr_accessor :policies + + # List of proxy names included in the API proxy revision. + # Corresponds to the JSON property `proxies` + # @return [Array] + attr_accessor :proxies + + # List of ProxyEndpoints in the `/proxies` directory of the API proxy. + # Typically, this element is included only when the API proxy was created + # using the Edge UI. This is a 'manifest' setting designed to + # provide visibility into the contents of the API proxy. + # Corresponds to the JSON property `proxyEndpoints` + # @return [Array] + attr_accessor :proxy_endpoints + + # List of resource files. + # Corresponds to the JSON property `resourceFiles` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFiles] + attr_accessor :resource_files + + # List of the resources included in the API proxy revision formatted as + # "`type`://`name`". + # Corresponds to the JSON property `resources` + # @return [Array] + attr_accessor :resources + + # API proxy revision. + # Corresponds to the JSON property `revision` + # @return [String] + attr_accessor :revision + + # List of the shared flows included in the API proxy revision. + # Corresponds to the JSON property `sharedFlows` + # @return [Array] + attr_accessor :shared_flows + + # OpenAPI Specification that is associated with the API proxy. + # The value is set to a URL or to a path in the specification store. + # Corresponds to the JSON property `spec` + # @return [String] + attr_accessor :spec + + # List of TargetEndpoints in the `/targets` directory of the API proxy. + # Typically, this element is included only when the API proxy was created + # using the Edge UI. This is a 'manifest' setting designed to + # provide visibility into the contents of the API proxy. + # Corresponds to the JSON property `targetEndpoints` + # @return [Array] + attr_accessor :target_endpoints + + # List of TargetServers referenced in any TargetEndpoint in the API + # proxy. Typically, you will see this element only when the API proxy was + # created using the Edge UI. This is a 'manifest' setting + # designed to provide visibility into the contents of the API proxy. + # Corresponds to the JSON property `targetServers` + # @return [Array] + attr_accessor :target_servers + + # List of the targets included in the API proxy revision. + # Corresponds to the JSON property `targets` + # @return [Array] + attr_accessor :targets + + # List of the teams included in the API proxy revision. + # Corresponds to the JSON property `teams` + # @return [Array] + attr_accessor :teams + + # Type. Set to `Application`. Maintained for compatibility with + # the Apigee Edge API. + # 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) + @basepaths = args[:basepaths] if args.key?(:basepaths) + @configuration_version = args[:configuration_version] if args.key?(:configuration_version) + @context_info = args[:context_info] if args.key?(:context_info) + @created_at = args[:created_at] if args.key?(:created_at) + @description = args[:description] if args.key?(:description) + @display_name = args[:display_name] if args.key?(:display_name) + @entity_meta_data_as_properties = args[:entity_meta_data_as_properties] if args.key?(:entity_meta_data_as_properties) + @last_modified_at = args[:last_modified_at] if args.key?(:last_modified_at) + @name = args[:name] if args.key?(:name) + @policies = args[:policies] if args.key?(:policies) + @proxies = args[:proxies] if args.key?(:proxies) + @proxy_endpoints = args[:proxy_endpoints] if args.key?(:proxy_endpoints) + @resource_files = args[:resource_files] if args.key?(:resource_files) + @resources = args[:resources] if args.key?(:resources) + @revision = args[:revision] if args.key?(:revision) + @shared_flows = args[:shared_flows] if args.key?(:shared_flows) + @spec = args[:spec] if args.key?(:spec) + @target_endpoints = args[:target_endpoints] if args.key?(:target_endpoints) + @target_servers = args[:target_servers] if args.key?(:target_servers) + @targets = args[:targets] if args.key?(:targets) + @teams = args[:teams] if args.key?(:teams) + @type = args[:type] if args.key?(:type) + end + end + + # + class GoogleCloudApigeeV1App + include Google::Apis::Core::Hashable + + # List of API products associated with the app. + # Corresponds to the JSON property `apiProducts` + # @return [Array] + attr_accessor :api_products + + # ID of the app. + # Corresponds to the JSON property `appId` + # @return [String] + attr_accessor :app_id + + # List of attributes. + # Corresponds to the JSON property `attributes` + # @return [Array] + attr_accessor :attributes + + # Callback URL used by OAuth 2.0 authorization servers to communicate + # authorization codes back to apps. + # Corresponds to the JSON property `callbackUrl` + # @return [String] + attr_accessor :callback_url + + # Name of the company that owns the app. + # Corresponds to the JSON property `companyName` + # @return [String] + attr_accessor :company_name + + # Output only. Unix time when the app was created. + # Corresponds to the JSON property `createdAt` + # @return [Fixnum] + attr_accessor :created_at + + # Output only. Set of credentials for the app. Credentials are API + # key/secret pairs associated with API products. + # Corresponds to the JSON property `credentials` + # @return [Array] + attr_accessor :credentials + + # ID of the developer. + # Corresponds to the JSON property `developerId` + # @return [String] + attr_accessor :developer_id + + # Duration, in milliseconds, of the consumer key that will + # be generated for the app. The default value, -1, indicates an + # infinite validity period. Once set, the expiration can't be updated. + # json key: keyExpiresIn + # Corresponds to the JSON property `keyExpiresIn` + # @return [Fixnum] + attr_accessor :key_expires_in + + # Output only. Last modified time as milliseconds since epoch. + # Corresponds to the JSON property `lastModifiedAt` + # @return [Fixnum] + attr_accessor :last_modified_at + + # Name of the app. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Scopes to apply to the app. The specified scope names must already + # exist on the API product that you associate with the app. + # Corresponds to the JSON property `scopes` + # @return [Array] + attr_accessor :scopes + + # Status of the credential. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @api_products = args[:api_products] if args.key?(:api_products) + @app_id = args[:app_id] if args.key?(:app_id) + @attributes = args[:attributes] if args.key?(:attributes) + @callback_url = args[:callback_url] if args.key?(:callback_url) + @company_name = args[:company_name] if args.key?(:company_name) + @created_at = args[:created_at] if args.key?(:created_at) + @credentials = args[:credentials] if args.key?(:credentials) + @developer_id = args[:developer_id] if args.key?(:developer_id) + @key_expires_in = args[:key_expires_in] if args.key?(:key_expires_in) + @last_modified_at = args[:last_modified_at] if args.key?(:last_modified_at) + @name = args[:name] if args.key?(:name) + @scopes = args[:scopes] if args.key?(:scopes) + @status = args[:status] if args.key?(:status) + end + end + + # + class GoogleCloudApigeeV1AsyncQuery + include Google::Apis::Core::Hashable + + # Creation time of the query + # Corresponds to the JSON property `created` + # @return [String] + attr_accessor :created + + # Error is set when query fails + # Corresponds to the JSON property `error` + # @return [String] + attr_accessor :error + + # ExecutionTime is available only after the query is completed + # Corresponds to the JSON property `executionTime` + # @return [String] + attr_accessor :execution_time + + # Asynchronous Query Name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Contains information like metrics, dimenstions etc + # of the AsyncQuery + # Corresponds to the JSON property `queryParams` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1QueryMetadata] + attr_accessor :query_params + + # Asynchronous Report ID. + # Corresponds to the JSON property `reportDefinitionId` + # @return [String] + attr_accessor :report_definition_id + + # Result is available only after the query is completed + # Corresponds to the JSON property `result` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQueryResult] + attr_accessor :result + + # ResultFileSize is available only after the query is completed + # Corresponds to the JSON property `resultFileSize` + # @return [String] + attr_accessor :result_file_size + + # ResultRows is available only after the query is completed + # Corresponds to the JSON property `resultRows` + # @return [Fixnum] + attr_accessor :result_rows + + # Self link of the query + # Example: + # `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f- + # 318d0cb961bd` + # Corresponds to the JSON property `self` + # @return [String] + attr_accessor :self + + # Query state could be "enqueued", "running", "completed", + # "failed" + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # Last updated timestamp for the query + # Corresponds to the JSON property `updated` + # @return [String] + attr_accessor :updated + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @created = args[:created] if args.key?(:created) + @error = args[:error] if args.key?(:error) + @execution_time = args[:execution_time] if args.key?(:execution_time) + @name = args[:name] if args.key?(:name) + @query_params = args[:query_params] if args.key?(:query_params) + @report_definition_id = args[:report_definition_id] if args.key?(:report_definition_id) + @result = args[:result] if args.key?(:result) + @result_file_size = args[:result_file_size] if args.key?(:result_file_size) + @result_rows = args[:result_rows] if args.key?(:result_rows) + @self = args[:self] if args.key?(:self) + @state = args[:state] if args.key?(:state) + @updated = args[:updated] if args.key?(:updated) + end + end + + # + class GoogleCloudApigeeV1AsyncQueryResult + include Google::Apis::Core::Hashable + + # Query result will be unaccessable after this time. + # Corresponds to the JSON property `expires` + # @return [String] + attr_accessor :expires + + # Self link of the query results + # Example: + # `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f- + # 318d0cb961bd/result` + # Corresponds to the JSON property `self` + # @return [String] + attr_accessor :self + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @expires = args[:expires] if args.key?(:expires) + @self = args[:self] if args.key?(:self) + end + end + + # + class GoogleCloudApigeeV1AsyncQueryResultView + include Google::Apis::Core::Hashable + + # Error code when there is a failure. + # Corresponds to the JSON property `code` + # @return [Fixnum] + attr_accessor :code + + # Error message when there is a failure. + # Corresponds to the JSON property `error` + # @return [String] + attr_accessor :error + + # Metadata contains information like metrics, dimenstions etc + # of the AsyncQuery + # Corresponds to the JSON property `metadata` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1QueryMetadata] + attr_accessor :metadata + + # Rows of query result. Each row is a JSON object. + # Example: `sum(message_count): 1, developer_app: "(not set)",…` + # Corresponds to the JSON property `rows` + # @return [Array] + attr_accessor :rows + + # State of retrieving ResultView. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @error = args[:error] if args.key?(:error) + @metadata = args[:metadata] if args.key?(:metadata) + @rows = args[:rows] if args.key?(:rows) + @state = args[:state] if args.key?(:state) + end + end + + # Key-value pair to store extra metadata. + class GoogleCloudApigeeV1Attribute + include Google::Apis::Core::Hashable + + # API key of the attribute. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Value of the attribute. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @value = args[:value] if args.key?(:value) + end + end + + # + class GoogleCloudApigeeV1Attributes + include Google::Apis::Core::Hashable + + # List of attributes. + # Corresponds to the JSON property `attribute` + # @return [Array] + attr_accessor :attribute + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @attribute = args[:attribute] if args.key?(:attribute) + end + end + + # An X.509 certificate as defined in RFC 5280. + class GoogleCloudApigeeV1CertInfo + include Google::Apis::Core::Hashable + + # The X.509 basic constraints extension. + # Corresponds to the JSON property `basicConstraints` + # @return [String] + attr_accessor :basic_constraints + + # The X.509 validity / notAfter in milliseconds since the epoch. + # Corresponds to the JSON property `expiryDate` + # @return [Fixnum] + attr_accessor :expiry_date + + # "Yes" if certificate is valid, "No" if expired and "Not yet" + # if not yet valid. + # Corresponds to the JSON property `isValid` + # @return [String] + attr_accessor :is_valid + + # The X.509 issuer. + # Corresponds to the JSON property `issuer` + # @return [String] + attr_accessor :issuer + + # The public key component of the X.509 subject public key info. + # Corresponds to the JSON property `publicKey` + # @return [String] + attr_accessor :public_key + + # The X.509 serial number. + # Corresponds to the JSON property `serialNumber` + # @return [String] + attr_accessor :serial_number + + # The X.509 signatureAlgorithm. + # Corresponds to the JSON property `sigAlgName` + # @return [String] + attr_accessor :sig_alg_name + + # The X.509 subject. + # Corresponds to the JSON property `subject` + # @return [String] + attr_accessor :subject + + # The X.509 subject alternative names (SANs) extension. + # Corresponds to the JSON property `subjectAlternativeNames` + # @return [Array] + attr_accessor :subject_alternative_names + + # The X.509 validity / notBefore in milliseconds since the + # epoch. + # Corresponds to the JSON property `validFrom` + # @return [Fixnum] + attr_accessor :valid_from + + # The X.509 version. + # 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) + @basic_constraints = args[:basic_constraints] if args.key?(:basic_constraints) + @expiry_date = args[:expiry_date] if args.key?(:expiry_date) + @is_valid = args[:is_valid] if args.key?(:is_valid) + @issuer = args[:issuer] if args.key?(:issuer) + @public_key = args[:public_key] if args.key?(:public_key) + @serial_number = args[:serial_number] if args.key?(:serial_number) + @sig_alg_name = args[:sig_alg_name] if args.key?(:sig_alg_name) + @subject = args[:subject] if args.key?(:subject) + @subject_alternative_names = args[:subject_alternative_names] if args.key?(:subject_alternative_names) + @valid_from = args[:valid_from] if args.key?(:valid_from) + @version = args[:version] if args.key?(:version) + end + end + + # + class GoogleCloudApigeeV1Certificate + include Google::Apis::Core::Hashable + + # The chain of certificates under this name. + # Corresponds to the JSON property `certInfo` + # @return [Array] + attr_accessor :cert_info + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cert_info = args[:cert_info] if args.key?(:cert_info) + end + end + + # + class GoogleCloudApigeeV1CommonNameConfig + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `matchWildCards` + # @return [Boolean] + attr_accessor :match_wild_cards + alias_method :match_wild_cards?, :match_wild_cards + + # + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @match_wild_cards = args[:match_wild_cards] if args.key?(:match_wild_cards) + @name = args[:name] if args.key?(:name) + end + end + + # + class GoogleCloudApigeeV1Company + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `apps` + # @return [Array] + attr_accessor :apps + + # A list of attributes + # Corresponds to the JSON property `attributes` + # @return [Array] + attr_accessor :attributes + + # Output only. Created time as milliseconds since epoch. + # json key: createdAt + # Corresponds to the JSON property `createdAt` + # @return [Fixnum] + attr_accessor :created_at + + # company name displayed in the UI + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Output only. Modified time as milliseconds since epoch. + # json key: lastModifiedAt + # Corresponds to the JSON property `lastModifiedAt` + # @return [Fixnum] + attr_accessor :last_modified_at + + # Name of the company. Characters you can use in the name are restricted to: + # A-Z0-9._\-$ %. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # the org that the company is created + # Corresponds to the JSON property `organization` + # @return [String] + attr_accessor :organization + + # The status of the company + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @apps = args[:apps] if args.key?(:apps) + @attributes = args[:attributes] if args.key?(:attributes) + @created_at = args[:created_at] if args.key?(:created_at) + @display_name = args[:display_name] if args.key?(:display_name) + @last_modified_at = args[:last_modified_at] if args.key?(:last_modified_at) + @name = args[:name] if args.key?(:name) + @organization = args[:organization] if args.key?(:organization) + @status = args[:status] if args.key?(:status) + end + end + + # + class GoogleCloudApigeeV1CompanyApp + include Google::Apis::Core::Hashable + + # Any API Products the app consumes + # Corresponds to the JSON property `apiProducts` + # @return [Array] + attr_accessor :api_products + + # + # Corresponds to the JSON property `appFamily` + # @return [String] + attr_accessor :app_family + + # The id of the app. + # Corresponds to the JSON property `appId` + # @return [String] + attr_accessor :app_id + + # A list of attributes. + # Corresponds to the JSON property `attributes` + # @return [Array] + attr_accessor :attributes + + # The callbackUrl is used by OAuth 2.0 authorization servers to communicate + # authorization codes back to apps. + # Corresponds to the JSON property `callbackUrl` + # @return [String] + attr_accessor :callback_url + + # The name of the company owns the app + # Corresponds to the JSON property `companyName` + # @return [String] + attr_accessor :company_name + + # Output only. created time of this environment as milliseconds since epoch. + # JSON key: createdAt + # Corresponds to the JSON property `createdAt` + # @return [Fixnum] + attr_accessor :created_at + + # Output only. A set of credentials for the app + # credentials are key/secret pairs + # Corresponds to the JSON property `credentials` + # @return [Array] + attr_accessor :credentials + + # A setting, in milliseconds, for the lifetime of the consumer key that will + # be generated for the developer app. The default value, -1, indicates an + # infinite validity period. Once set, the expiration can't be updated. + # json key: keyExpiresIn + # Corresponds to the JSON property `keyExpiresIn` + # @return [Fixnum] + attr_accessor :key_expires_in + + # Output only. Modified time as milliseconds since epoch. + # json key: lastModifiedAt + # Corresponds to the JSON property `lastModifiedAt` + # @return [Fixnum] + attr_accessor :last_modified_at + + # The resoure id of the app. + # JSON key: name + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The scopes to apply to the app. The specified scope names must already + # exist on the API product that you associate with the app. + # Corresponds to the JSON property `scopes` + # @return [Array] + attr_accessor :scopes + + # The status of the credential. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @api_products = args[:api_products] if args.key?(:api_products) + @app_family = args[:app_family] if args.key?(:app_family) + @app_id = args[:app_id] if args.key?(:app_id) + @attributes = args[:attributes] if args.key?(:attributes) + @callback_url = args[:callback_url] if args.key?(:callback_url) + @company_name = args[:company_name] if args.key?(:company_name) + @created_at = args[:created_at] if args.key?(:created_at) + @credentials = args[:credentials] if args.key?(:credentials) + @key_expires_in = args[:key_expires_in] if args.key?(:key_expires_in) + @last_modified_at = args[:last_modified_at] if args.key?(:last_modified_at) + @name = args[:name] if args.key?(:name) + @scopes = args[:scopes] if args.key?(:scopes) + @status = args[:status] if args.key?(:status) + end + end + + # + class GoogleCloudApigeeV1CompanyAppKey + include Google::Apis::Core::Hashable + + # A list of api products this credential can be used for. + # Corresponds to the JSON property `apiProducts` + # @return [Array] + attr_accessor :api_products + + # A list of attributes tied to the credential. + # Corresponds to the JSON property `attributes` + # @return [Array] + attr_accessor :attributes + + # The consumer key. + # Corresponds to the JSON property `consumerKey` + # @return [String] + attr_accessor :consumer_key + + # The secret key. + # Corresponds to the JSON property `consumerSecret` + # @return [String] + attr_accessor :consumer_secret + + # Unix time when the app was created + # json key: expiresAt + # Corresponds to the JSON property `expiresAt` + # @return [Fixnum] + attr_accessor :expires_at + + # Unix time when the app was issued + # json key: issuedAt + # Corresponds to the JSON property `issuedAt` + # @return [Fixnum] + attr_accessor :issued_at + + # The scopes to apply to the app. The specified scope names must already + # exist on the API product that you associate with the app. + # Corresponds to the JSON property `scopes` + # @return [Array] + attr_accessor :scopes + + # The status of the credential. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @api_products = args[:api_products] if args.key?(:api_products) + @attributes = args[:attributes] if args.key?(:attributes) + @consumer_key = args[:consumer_key] if args.key?(:consumer_key) + @consumer_secret = args[:consumer_secret] if args.key?(:consumer_secret) + @expires_at = args[:expires_at] if args.key?(:expires_at) + @issued_at = args[:issued_at] if args.key?(:issued_at) + @scopes = args[:scopes] if args.key?(:scopes) + @status = args[:status] if args.key?(:status) + end + end + + # Version of the API proxy configuration schema. Currently, only 4.0 is + # supported. + class GoogleCloudApigeeV1ConfigVersion + include Google::Apis::Core::Hashable + + # Major version of the API proxy configuration schema. + # Corresponds to the JSON property `majorVersion` + # @return [Fixnum] + attr_accessor :major_version + + # Minor version of the API proxy configuration schema. + # Corresponds to the JSON property `minorVersion` + # @return [Fixnum] + attr_accessor :minor_version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @major_version = args[:major_version] if args.key?(:major_version) + @minor_version = args[:minor_version] if args.key?(:minor_version) + end + end + + # + class GoogleCloudApigeeV1Credential + include Google::Apis::Core::Hashable + + # List of API products this credential can be used for. + # Corresponds to the JSON property `apiProducts` + # @return [Array] + attr_accessor :api_products + + # List of attributes associated with this credential. + # Corresponds to the JSON property `attributes` + # @return [Array] + attr_accessor :attributes + + # Consumer key. + # Corresponds to the JSON property `consumerKey` + # @return [String] + attr_accessor :consumer_key + + # Secret key. + # Corresponds to the JSON property `consumerSecret` + # @return [String] + attr_accessor :consumer_secret + + # Time the credential will expire in milliseconds since epoch. + # Corresponds to the JSON property `expiresAt` + # @return [Fixnum] + attr_accessor :expires_at + + # Time the credential was issued in milliseconds since epoch. + # Corresponds to the JSON property `issuedAt` + # @return [Fixnum] + attr_accessor :issued_at + + # List of scopes to apply to the app. Specified scopes must already + # exist on the API product that you associate with the app. + # Corresponds to the JSON property `scopes` + # @return [Array] + attr_accessor :scopes + + # Status of the credential. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @api_products = args[:api_products] if args.key?(:api_products) + @attributes = args[:attributes] if args.key?(:attributes) + @consumer_key = args[:consumer_key] if args.key?(:consumer_key) + @consumer_secret = args[:consumer_secret] if args.key?(:consumer_secret) + @expires_at = args[:expires_at] if args.key?(:expires_at) + @issued_at = args[:issued_at] if args.key?(:issued_at) + @scopes = args[:scopes] if args.key?(:scopes) + @status = args[:status] if args.key?(:status) + end + end + + # + class GoogleCloudApigeeV1CustomReport + include Google::Apis::Core::Hashable + + # This field contains the chart type for the report + # Corresponds to the JSON property `chartType` + # @return [String] + attr_accessor :chart_type + + # Legacy field: not used. This field contains a list of comments associated + # with custom report + # Corresponds to the JSON property `comments` + # @return [Array] + attr_accessor :comments + + # Output only. Unix time when the app was created + # json key: createdAt + # Corresponds to the JSON property `createdAt` + # @return [Fixnum] + attr_accessor :created_at + + # This contains the list of dimensions for the report + # Corresponds to the JSON property `dimensions` + # @return [Array] + attr_accessor :dimensions + + # This is the display name for the report + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Output only. Environment name + # Corresponds to the JSON property `environment` + # @return [String] + attr_accessor :environment + + # This field contains the filter expression + # Corresponds to the JSON property `filter` + # @return [String] + attr_accessor :filter + + # Legacy field: not used. Contains the from time for the report + # Corresponds to the JSON property `fromTime` + # @return [String] + attr_accessor :from_time + + # Output only. Modified time of this entity as milliseconds since epoch. + # json key: lastModifiedAt + # Corresponds to the JSON property `lastModifiedAt` + # @return [Fixnum] + attr_accessor :last_modified_at + + # Output only. Last viewed time of this entity as milliseconds since epoch + # Corresponds to the JSON property `lastViewedAt` + # @return [Fixnum] + attr_accessor :last_viewed_at + + # Legacy field: not used This field contains the limit for the result + # retrieved + # Corresponds to the JSON property `limit` + # @return [String] + attr_accessor :limit + + # Required. This contains the list of metrics + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # Required. Unique identifier for the report + # T his is a legacy field used to encode custom report unique id + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Legacy field: not used. This field contains the offset for the data + # Corresponds to the JSON property `offset` + # @return [String] + attr_accessor :offset + + # Output only. Organization name + # Corresponds to the JSON property `organization` + # @return [String] + attr_accessor :organization + + # This field contains report properties such as ui metadata etc. + # Corresponds to the JSON property `properties` + # @return [Array] + attr_accessor :properties + + # Legacy field: not used much. Contains the list of sort by columns + # Corresponds to the JSON property `sortByCols` + # @return [Array] + attr_accessor :sort_by_cols + + # Legacy field: not used much. Contains the sort order for the sort columns + # Corresponds to the JSON property `sortOrder` + # @return [String] + attr_accessor :sort_order + + # Legacy field: not used. This field contains a list of tags associated with + # custom report + # Corresponds to the JSON property `tags` + # @return [Array] + attr_accessor :tags + + # This field contains the time unit of aggregation for the report + # Corresponds to the JSON property `timeUnit` + # @return [String] + attr_accessor :time_unit + + # Legacy field: not used. Contains the end time for the report + # Corresponds to the JSON property `toTime` + # @return [String] + attr_accessor :to_time + + # Legacy field: not used. This field contains the top k parameter value + # for restricting the result + # Corresponds to the JSON property `topk` + # @return [String] + attr_accessor :topk + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @chart_type = args[:chart_type] if args.key?(:chart_type) + @comments = args[:comments] if args.key?(:comments) + @created_at = args[:created_at] if args.key?(:created_at) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @display_name = args[:display_name] if args.key?(:display_name) + @environment = args[:environment] if args.key?(:environment) + @filter = args[:filter] if args.key?(:filter) + @from_time = args[:from_time] if args.key?(:from_time) + @last_modified_at = args[:last_modified_at] if args.key?(:last_modified_at) + @last_viewed_at = args[:last_viewed_at] if args.key?(:last_viewed_at) + @limit = args[:limit] if args.key?(:limit) + @metrics = args[:metrics] if args.key?(:metrics) + @name = args[:name] if args.key?(:name) + @offset = args[:offset] if args.key?(:offset) + @organization = args[:organization] if args.key?(:organization) + @properties = args[:properties] if args.key?(:properties) + @sort_by_cols = args[:sort_by_cols] if args.key?(:sort_by_cols) + @sort_order = args[:sort_order] if args.key?(:sort_order) + @tags = args[:tags] if args.key?(:tags) + @time_unit = args[:time_unit] if args.key?(:time_unit) + @to_time = args[:to_time] if args.key?(:to_time) + @topk = args[:topk] if args.key?(:topk) + end + end + + # This encapsulates a metric property of the form sum(message_count) + # where name is message_count and function is sum + class GoogleCloudApigeeV1CustomReportMetric + include Google::Apis::Core::Hashable + + # aggregate function + # Corresponds to the JSON property `function` + # @return [String] + attr_accessor :function + + # name of the metric + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @function = args[:function] if args.key?(:function) + @name = args[:name] if args.key?(:name) + end + end + + # + class GoogleCloudApigeeV1DataLocation + include Google::Apis::Core::Hashable + + # GCS signed url. Signed URLs provide a way to give time-limited + # read or write access to anyone in possession of the URL, regardless of + # whether they have a Google account. + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @url = args[:url] if args.key?(:url) + end + end + + # + class GoogleCloudApigeeV1DebugMask + include Google::Apis::Core::Hashable + + # List of JSON paths that specify the JSON elements to be filtered from JSON + # payloads in error flows. + # Corresponds to the JSON property `faultJSONPaths` + # @return [Array] + attr_accessor :fault_json_paths + + # List of XPaths that specify the XML elements to be filtered from XML + # payloads in error flows. + # Corresponds to the JSON property `faultXPaths` + # @return [Array] + attr_accessor :fault_x_paths + + # Name of the debug mask. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Map of namespaces to URIs. + # Corresponds to the JSON property `namespaces` + # @return [Hash] + attr_accessor :namespaces + + # List of JSON paths that specify the JSON elements to be filtered from JSON + # request message payloads. + # Corresponds to the JSON property `requestJSONPaths` + # @return [Array] + attr_accessor :request_json_paths + + # List of XPaths that specify the XML elements to be filtered from XML + # request message payloads. + # Corresponds to the JSON property `requestXPaths` + # @return [Array] + attr_accessor :request_x_paths + + # List of JSON paths that specify the JSON elements to be filtered from JSON + # response message payloads. + # Corresponds to the JSON property `responseJSONPaths` + # @return [Array] + attr_accessor :response_json_paths + + # List of XPaths that specify the XML elements to be filtered from XML + # response message payloads. + # Corresponds to the JSON property `responseXPaths` + # @return [Array] + attr_accessor :response_x_paths + + # List of variables that should be masked from the debug output. + # Corresponds to the JSON property `variables` + # @return [Array] + attr_accessor :variables + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @fault_json_paths = args[:fault_json_paths] if args.key?(:fault_json_paths) + @fault_x_paths = args[:fault_x_paths] if args.key?(:fault_x_paths) + @name = args[:name] if args.key?(:name) + @namespaces = args[:namespaces] if args.key?(:namespaces) + @request_json_paths = args[:request_json_paths] if args.key?(:request_json_paths) + @request_x_paths = args[:request_x_paths] if args.key?(:request_x_paths) + @response_json_paths = args[:response_json_paths] if args.key?(:response_json_paths) + @response_x_paths = args[:response_x_paths] if args.key?(:response_x_paths) + @variables = args[:variables] if args.key?(:variables) + end + end + + # + class GoogleCloudApigeeV1DebugSession + include Google::Apis::Core::Hashable + + # Optional. The number of request to be traced. Min = 1, Max = 15, Default + # = 10. + # Corresponds to the JSON property `count` + # @return [Fixnum] + attr_accessor :count + + # Optional. A conditional statement which is evaluated against the request + # message to determine if it should be traced. Syntax matches that of on + # API Proxy bundle flow Condition. + # Corresponds to the JSON property `filter` + # @return [String] + attr_accessor :filter + + # A unique ID for this DebugSession. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Optional. The time in seconds after which this DebugSession should end. + # This value will override the value in query param, if both are provided. + # Corresponds to the JSON property `timeout` + # @return [Fixnum] + attr_accessor :timeout + + # Optional. The maximum number of bytes captured from the response payload. + # Min = 0, Max = 5120, Default = 5120. + # Corresponds to the JSON property `tracesize` + # @return [Fixnum] + attr_accessor :tracesize + + # Optional. The length of time, in seconds, that this debug session is valid, + # starting from when it's received in the control plane. Min = 1, Max = 15, + # Default = 10. + # Corresponds to the JSON property `validity` + # @return [Fixnum] + attr_accessor :validity + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @count = args[:count] if args.key?(:count) + @filter = args[:filter] if args.key?(:filter) + @name = args[:name] if args.key?(:name) + @timeout = args[:timeout] if args.key?(:timeout) + @tracesize = args[:tracesize] if args.key?(:tracesize) + @validity = args[:validity] if args.key?(:validity) + end + end + + # A transaction contains all of the debug information of the entire message + # flow of an API call processed by the runtime plane. The information is + # collected and recorded at critical points of the message flow in the runtime + # apiproxy. + class GoogleCloudApigeeV1DebugSessionTransaction + include Google::Apis::Core::Hashable + + # Flag indicating whether a transaction is completed or not + # Corresponds to the JSON property `completed` + # @return [Boolean] + attr_accessor :completed + alias_method :completed?, :completed + + # List of debug data collected by runtime plane at various defined points in + # the flow. + # Corresponds to the JSON property `point` + # @return [Array] + attr_accessor :point + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @completed = args[:completed] if args.key?(:completed) + @point = args[:point] if args.key?(:point) + end + end + + # + class GoogleCloudApigeeV1DeleteCustomReportResponse + include Google::Apis::Core::Hashable + + # The response contains only a message field. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @message = args[:message] if args.key?(:message) + end + end + + # + class GoogleCloudApigeeV1Deployment + include Google::Apis::Core::Hashable + + # API proxy. + # Corresponds to the JSON property `apiProxy` + # @return [String] + attr_accessor :api_proxy + + # Base path for the deployment. + # Corresponds to the JSON property `basePath` + # @return [String] + attr_accessor :base_path + + # Time the API proxy was marked `deployed` in the control plane in + # millisconds since epoch. + # Corresponds to the JSON property `deployStartTime` + # @return [Fixnum] + attr_accessor :deploy_start_time + + # Environment. + # Corresponds to the JSON property `environment` + # @return [String] + attr_accessor :environment + + # Status reported by runtime pods. + # Corresponds to the JSON property `pods` + # @return [Array] + attr_accessor :pods + + # API proxy revision. + # Corresponds to the JSON property `revision` + # @return [String] + attr_accessor :revision + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @api_proxy = args[:api_proxy] if args.key?(:api_proxy) + @base_path = args[:base_path] if args.key?(:base_path) + @deploy_start_time = args[:deploy_start_time] if args.key?(:deploy_start_time) + @environment = args[:environment] if args.key?(:environment) + @pods = args[:pods] if args.key?(:pods) + @revision = args[:revision] if args.key?(:revision) + end + end + + # + class GoogleCloudApigeeV1DeploymentConfig + include Google::Apis::Core::Hashable + + # Additional key-value metadata about the deployment. + # Corresponds to the JSON property `attributes` + # @return [Hash] + attr_accessor :attributes + + # Base path where the application needs to be hosted. Default value is + # assumed to be "/". + # Corresponds to the JSON property `basePath` + # @return [String] + attr_accessor :base_path + + # The location of the proxy bundle, as a uri. + # Corresponds to the JSON property `location` + # @return [String] + attr_accessor :location + + # The name of the API or shared flow revision to be deployed. Must be of the + # form 'organizations/`org`/apis/`api`/revisions/`rev`' or + # 'organizations/`org`/sharedflows/`sf`/revisions/`rev`'. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @attributes = args[:attributes] if args.key?(:attributes) + @base_path = args[:base_path] if args.key?(:base_path) + @location = args[:location] if args.key?(:location) + @name = args[:name] if args.key?(:name) + end + end + + # + class GoogleCloudApigeeV1Developer + include Google::Apis::Core::Hashable + + # Access type. + # Corresponds to the JSON property `accessType` + # @return [String] + attr_accessor :access_type + + # Developer app family. + # Corresponds to the JSON property `appFamily` + # @return [String] + attr_accessor :app_family + + # List of apps associated with the developer. + # Corresponds to the JSON property `apps` + # @return [Array] + attr_accessor :apps + + # Optional. Developer attributes (name/value pairs). The custom attribute limit + # is 18. + # Corresponds to the JSON property `attributes` + # @return [Array] + attr_accessor :attributes + + # List of companies associated with the developer. + # Corresponds to the JSON property `companies` + # @return [Array] + attr_accessor :companies + + # Output only. Time at which the developer was created in milliseconds + # since epoch. + # Corresponds to the JSON property `createdAt` + # @return [Fixnum] + attr_accessor :created_at + + # ID of the developer. + # **Note**: IDs are generated internally by Apigee and are not + # guaranteed to stay the same over time. + # Corresponds to the JSON property `developerId` + # @return [String] + attr_accessor :developer_id + + # Required. Email address of the developer. This value is used to uniquely + # identify + # the developer in Apigee hybrid. + # Corresponds to the JSON property `email` + # @return [String] + attr_accessor :email + + # Required. First name of the developer. + # Corresponds to the JSON property `firstName` + # @return [String] + attr_accessor :first_name + + # Output only. Time at which the developer was last modified in + # milliseconds since epoch. + # Corresponds to the JSON property `lastModifiedAt` + # @return [Fixnum] + attr_accessor :last_modified_at + + # Required. Last name of the developer. + # Corresponds to the JSON property `lastName` + # @return [String] + attr_accessor :last_name + + # Output only. Name of the Apigee organization in which the developer resides. + # Corresponds to the JSON property `organizationName` + # @return [String] + attr_accessor :organization_name + + # Output only. Status of the developer. Valid values are `active` and `inactive`. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + # Required. User name of the developer. Not used by Apigee hybrid. + # Corresponds to the JSON property `userName` + # @return [String] + attr_accessor :user_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @access_type = args[:access_type] if args.key?(:access_type) + @app_family = args[:app_family] if args.key?(:app_family) + @apps = args[:apps] if args.key?(:apps) + @attributes = args[:attributes] if args.key?(:attributes) + @companies = args[:companies] if args.key?(:companies) + @created_at = args[:created_at] if args.key?(:created_at) + @developer_id = args[:developer_id] if args.key?(:developer_id) + @email = args[:email] if args.key?(:email) + @first_name = args[:first_name] if args.key?(:first_name) + @last_modified_at = args[:last_modified_at] if args.key?(:last_modified_at) + @last_name = args[:last_name] if args.key?(:last_name) + @organization_name = args[:organization_name] if args.key?(:organization_name) + @status = args[:status] if args.key?(:status) + @user_name = args[:user_name] if args.key?(:user_name) + end + end + + # + class GoogleCloudApigeeV1DeveloperApp + include Google::Apis::Core::Hashable + + # List of API products associated with the developer app. + # Corresponds to the JSON property `apiProducts` + # @return [Array] + attr_accessor :api_products + + # Developer app family. + # Corresponds to the JSON property `appFamily` + # @return [String] + attr_accessor :app_family + + # ID of the developer app. + # Corresponds to the JSON property `appId` + # @return [String] + attr_accessor :app_id + + # List of attributes for the developer app. + # Corresponds to the JSON property `attributes` + # @return [Array] + attr_accessor :attributes + + # Callback URL used by OAuth 2.0 authorization servers to communicate + # authorization codes back to developer apps. + # Corresponds to the JSON property `callbackUrl` + # @return [String] + attr_accessor :callback_url + + # Output only. Time the developer app was created in milliseconds since epoch. + # Corresponds to the JSON property `createdAt` + # @return [Fixnum] + attr_accessor :created_at + + # Output only. Set of credentials for the developer app consisting of the + # consumer key/secret pairs associated with the API products. + # Corresponds to the JSON property `credentials` + # @return [Array] + attr_accessor :credentials + + # ID of the developer. + # Corresponds to the JSON property `developerId` + # @return [String] + attr_accessor :developer_id + + # Expiration time, in milliseconds, for the consumer key that + # is generated for the developer app. If not set or left to the default + # value of `-1`, the API key never expires. + # The expiration time can't be updated after it is set. + # Corresponds to the JSON property `keyExpiresIn` + # @return [Fixnum] + attr_accessor :key_expires_in + + # Output only. Time the developer app was modified in milliseconds since epoch. + # Corresponds to the JSON property `lastModifiedAt` + # @return [Fixnum] + attr_accessor :last_modified_at + + # Name of the developer app. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Scopes to apply to the developer app. The specified scopes must + # already exist for the API product that you associate with the developer + # app. + # Corresponds to the JSON property `scopes` + # @return [Array] + attr_accessor :scopes + + # Status of the credential. Valid values include `approved` or `revoked`. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @api_products = args[:api_products] if args.key?(:api_products) + @app_family = args[:app_family] if args.key?(:app_family) + @app_id = args[:app_id] if args.key?(:app_id) + @attributes = args[:attributes] if args.key?(:attributes) + @callback_url = args[:callback_url] if args.key?(:callback_url) + @created_at = args[:created_at] if args.key?(:created_at) + @credentials = args[:credentials] if args.key?(:credentials) + @developer_id = args[:developer_id] if args.key?(:developer_id) + @key_expires_in = args[:key_expires_in] if args.key?(:key_expires_in) + @last_modified_at = args[:last_modified_at] if args.key?(:last_modified_at) + @name = args[:name] if args.key?(:name) + @scopes = args[:scopes] if args.key?(:scopes) + @status = args[:status] if args.key?(:status) + end + end + + # + class GoogleCloudApigeeV1DeveloperAppKey + include Google::Apis::Core::Hashable + + # List of API products for which the credential can be used. + # Corresponds to the JSON property `apiProducts` + # @return [Array] + attr_accessor :api_products + + # List of attributes associated with the credential. + # Corresponds to the JSON property `attributes` + # @return [Array] + attr_accessor :attributes + + # Consumer key. + # Corresponds to the JSON property `consumerKey` + # @return [String] + attr_accessor :consumer_key + + # Secret key. + # Corresponds to the JSON property `consumerSecret` + # @return [String] + attr_accessor :consumer_secret + + # Time the developer app expires in milliseconds since epoch. + # Corresponds to the JSON property `expiresAt` + # @return [Fixnum] + attr_accessor :expires_at + + # Time the developer app was created in milliseconds since epoch. + # Corresponds to the JSON property `issuedAt` + # @return [Fixnum] + attr_accessor :issued_at + + # Scopes to apply to the app. The specified scope names must already + # be defined for the API product that you associate with the app. + # Corresponds to the JSON property `scopes` + # @return [Array] + attr_accessor :scopes + + # Status of the credential. Valid values include `approved` or `revoked`. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @api_products = args[:api_products] if args.key?(:api_products) + @attributes = args[:attributes] if args.key?(:attributes) + @consumer_key = args[:consumer_key] if args.key?(:consumer_key) + @consumer_secret = args[:consumer_secret] if args.key?(:consumer_secret) + @expires_at = args[:expires_at] if args.key?(:expires_at) + @issued_at = args[:issued_at] if args.key?(:issued_at) + @scopes = args[:scopes] if args.key?(:scopes) + @status = args[:status] if args.key?(:status) + end + end + + # This message type encapsulates a metric grouped by dimension + class GoogleCloudApigeeV1DimensionMetric + include Google::Apis::Core::Hashable + + # This field contains a list of metrics + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # This field contains the name of the dimension + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @metrics = args[:metrics] if args.key?(:metrics) + @name = args[:name] if args.key?(:name) + end + end + + # Metadata common to many entities in this API. + class GoogleCloudApigeeV1EntityMetadata + include Google::Apis::Core::Hashable + + # Time at which the API proxy was created, in milliseconds since epoch. + # Corresponds to the JSON property `createdAt` + # @return [Fixnum] + attr_accessor :created_at + + # Time at which the API proxy was most recently modified, in milliseconds + # since epoch. + # Corresponds to the JSON property `lastModifiedAt` + # @return [Fixnum] + attr_accessor :last_modified_at + + # The type of entity described + # Corresponds to the JSON property `subType` + # @return [String] + attr_accessor :sub_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @created_at = args[:created_at] if args.key?(:created_at) + @last_modified_at = args[:last_modified_at] if args.key?(:last_modified_at) + @sub_type = args[:sub_type] if args.key?(:sub_type) + end + end + + # + class GoogleCloudApigeeV1Environment + include Google::Apis::Core::Hashable + + # Output only. Creation time of this environment as milliseconds since epoch. + # Corresponds to the JSON property `createdAt` + # @return [Fixnum] + attr_accessor :created_at + + # Optional. Description of the environment. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Optional. Display name for this environment. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Output only. Last modification time of this environment as milliseconds + # since epoch. + # Corresponds to the JSON property `lastModifiedAt` + # @return [Fixnum] + attr_accessor :last_modified_at + + # Required. Name of the environment. Values must match the + # regular expression `^[.\\p`Alnum`-_]`1,255`$` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Message for compatibility with legacy Edge specification for Java Properties + # object in JSON. + # Corresponds to the JSON property `properties` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Properties] + attr_accessor :properties + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @created_at = args[:created_at] if args.key?(:created_at) + @description = args[:description] if args.key?(:description) + @display_name = args[:display_name] if args.key?(:display_name) + @last_modified_at = args[:last_modified_at] if args.key?(:last_modified_at) + @name = args[:name] if args.key?(:name) + @properties = args[:properties] if args.key?(:properties) + end + end + + # + class GoogleCloudApigeeV1EnvironmentConfig + include Google::Apis::Core::Hashable + + # The time at which this environment config was created. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Debug mask that applies to all deployments in the environment. + # Corresponds to the JSON property `debugMask` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask] + attr_accessor :debug_mask + + # A list of deployments in the environment + # Corresponds to the JSON property `deployments` + # @return [Array] + attr_accessor :deployments + + # Feature flags inherited from the org and environment parents. + # Corresponds to the JSON property `featureFlags` + # @return [Hash] + attr_accessor :feature_flags + + # A list of flow hooks in the environment. + # Corresponds to the JSON property `flowhooks` + # @return [Array] + attr_accessor :flowhooks + + # A list of keystores in the environment. + # Corresponds to the JSON property `keystores` + # @return [Array] + attr_accessor :keystores + + # The name of the environment config. Must be of the form + # 'organizations/`org`/environments/`env`/configs/`config_id` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # This field can be used by the control plane to add some context + # information about itself. This information could help detect the source of + # the document during diagnostics and debugging. + # Corresponds to the JSON property `provider` + # @return [String] + attr_accessor :provider + + # Name of the pubsub topic for this environment. + # Corresponds to the JSON property `pubsubTopic` + # @return [String] + attr_accessor :pubsub_topic + + # A list of resource references in the environment. + # Corresponds to the JSON property `resourceReferences` + # @return [Array] + attr_accessor :resource_references + + # A list of resource versions in the environment. + # Corresponds to the JSON property `resources` + # @return [Array] + attr_accessor :resources + + # A sequence number that defines an ordering on environment configs. No two + # configs under an environment will ever have the same sequence number. + # A higher sequence number means that the config was deployed more + # recently than one with a lower sequence number. + # Corresponds to the JSON property `sequenceNumber` + # @return [Fixnum] + attr_accessor :sequence_number + + # A list of target servers in the environment. Disabled target servers are + # not included. + # Corresponds to the JSON property `targets` + # @return [Array] + attr_accessor :targets + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @create_time = args[:create_time] if args.key?(:create_time) + @debug_mask = args[:debug_mask] if args.key?(:debug_mask) + @deployments = args[:deployments] if args.key?(:deployments) + @feature_flags = args[:feature_flags] if args.key?(:feature_flags) + @flowhooks = args[:flowhooks] if args.key?(:flowhooks) + @keystores = args[:keystores] if args.key?(:keystores) + @name = args[:name] if args.key?(:name) + @provider = args[:provider] if args.key?(:provider) + @pubsub_topic = args[:pubsub_topic] if args.key?(:pubsub_topic) + @resource_references = args[:resource_references] if args.key?(:resource_references) + @resources = args[:resources] if args.key?(:resources) + @sequence_number = args[:sequence_number] if args.key?(:sequence_number) + @targets = args[:targets] if args.key?(:targets) + end + end + + # + class GoogleCloudApigeeV1FlowHook + include Google::Apis::Core::Hashable + + # Optional. Flag that specifies whether execution should continue if the flow + # hook + # throws an exception. Set to `true` to continue execution. Set to + # `false` to stop execution if the flow hook throws an exception.Defaults + # to `true`. + # Corresponds to the JSON property `continueOnError` + # @return [Boolean] + attr_accessor :continue_on_error + alias_method :continue_on_error?, :continue_on_error + + # Description of the flow hook. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Output only. Where in the API call flow the flow hook is invoked. Must be one + # of + # `PreProxyFlowHook`, `PostProxyFlowHook`, `PreTargetFlowHook`, or + # `PostTargetFlowHook`. + # Corresponds to the JSON property `flowHookPoint` + # @return [String] + attr_accessor :flow_hook_point + + # Shared flow attached to this flow hook, or empty if there is none attached. + # Corresponds to the JSON property `sharedFlow` + # @return [String] + attr_accessor :shared_flow + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @continue_on_error = args[:continue_on_error] if args.key?(:continue_on_error) + @description = args[:description] if args.key?(:description) + @flow_hook_point = args[:flow_hook_point] if args.key?(:flow_hook_point) + @shared_flow = args[:shared_flow] if args.key?(:shared_flow) + end + end + + # + class GoogleCloudApigeeV1FlowHookConfig + include Google::Apis::Core::Hashable + + # Should the flow abort after an error in the flow hook. + # Should default to true if unset. + # Corresponds to the JSON property `continueOnError` + # @return [Boolean] + attr_accessor :continue_on_error + alias_method :continue_on_error?, :continue_on_error + + # The name of the flow hook. Must be of the form + # 'organizations/`org`/environments/`env`/flowhooks/`point`''. + # Known points are PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, + # and PostTargetFlowHook + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The name of the shared flow to invoke. Must be of the form + # 'organizations/`org`/sharedflows/`sharedflow`'. + # Corresponds to the JSON property `sharedFlowName` + # @return [String] + attr_accessor :shared_flow_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @continue_on_error = args[:continue_on_error] if args.key?(:continue_on_error) + @name = args[:name] if args.key?(:name) + @shared_flow_name = args[:shared_flow_name] if args.key?(:shared_flow_name) + end + end + + # Request for + # GetSyncAuthorization. + class GoogleCloudApigeeV1GetSyncAuthorizationRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # + class GoogleCloudApigeeV1KeyAliasReference + include Google::Apis::Core::Hashable + + # The alias id. Must exist in the keystore referred to by reference. + # Corresponds to the JSON property `aliasId` + # @return [String] + attr_accessor :alias_id + + # The reference name. Must be of the form: + # organizations/`org`/environments/`env`/references/`ref`. + # Corresponds to the JSON property `reference` + # @return [String] + attr_accessor :reference + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @alias_id = args[:alias_id] if args.key?(:alias_id) + @reference = args[:reference] if args.key?(:reference) + end + end + + # A collection of key, value string pairs + class GoogleCloudApigeeV1KeyValueMap + include Google::Apis::Core::Hashable + + # Optional. If `true` entry values will be encrypted. + # Corresponds to the JSON property `encrypted` + # @return [Boolean] + attr_accessor :encrypted + alias_method :encrypted?, :encrypted + + # Required. The id of the key value map. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @encrypted = args[:encrypted] if args.key?(:encrypted) + @name = args[:name] if args.key?(:name) + end + end + + # A datastore for Certificates and Aliases + class GoogleCloudApigeeV1Keystore + include Google::Apis::Core::Hashable + + # Output only. The aliases in this keystore. + # Corresponds to the JSON property `aliases` + # @return [Array] + attr_accessor :aliases + + # Required. The resource ID for this keystore. Values must match the + # regular expression `[\w[:space:]-.]`1,255``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @aliases = args[:aliases] if args.key?(:aliases) + @name = args[:name] if args.key?(:name) + end + end + + # + class GoogleCloudApigeeV1KeystoreConfig + include Google::Apis::Core::Hashable + + # Aliases in the keystore. + # Corresponds to the JSON property `aliases` + # @return [Array] + attr_accessor :aliases + + # The resource name. Must be of the + # form: + # 'organizations/`org`/environments/`env`/keystores/`keystore`'. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @aliases = args[:aliases] if args.key?(:aliases) + @name = args[:name] if args.key?(:name) + end + end + + # + class GoogleCloudApigeeV1ListApiProductsResponse + include Google::Apis::Core::Hashable + + # Lists all API product names defined for an organization. + # Corresponds to the JSON property `apiProduct` + # @return [Array] + attr_accessor :api_product + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @api_product = args[:api_product] if args.key?(:api_product) + end + end + + # + class GoogleCloudApigeeV1ListApiProxiesResponse + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `proxies` + # @return [Array] + attr_accessor :proxies + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @proxies = args[:proxies] if args.key?(:proxies) + end + end + + # + class GoogleCloudApigeeV1ListAppsResponse + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `app` + # @return [Array] + attr_accessor :app + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @app = args[:app] if args.key?(:app) + end + end + + # The response for ListAsyncQueries + class GoogleCloudApigeeV1ListAsyncQueriesResponse + include Google::Apis::Core::Hashable + + # The asynchronous queries belong to requested organization and environment + # Corresponds to the JSON property `queries` + # @return [Array] + attr_accessor :queries + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @queries = args[:queries] if args.key?(:queries) + end + end + + # + class GoogleCloudApigeeV1ListCompaniesResponse + include Google::Apis::Core::Hashable + + # A list of company. + # Corresponds to the JSON property `company` + # @return [Array] + attr_accessor :company + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @company = args[:company] if args.key?(:company) + end + end + + # + class GoogleCloudApigeeV1ListCompanyAppsResponse + include Google::Apis::Core::Hashable + + # A list of apps for a company. + # Corresponds to the JSON property `app` + # @return [Array] + attr_accessor :app + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @app = args[:app] if args.key?(:app) + end + end + + # This message encapsulates a list of custom report definitions + class GoogleCloudApigeeV1ListCustomReportsResponse + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `qualifier` + # @return [Array] + attr_accessor :qualifier + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @qualifier = args[:qualifier] if args.key?(:qualifier) + end + end + + # + class GoogleCloudApigeeV1ListDebugSessionsResponse + include Google::Apis::Core::Hashable + + # Session info that includes debug session ID and the first transaction + # creation timestamp. + # Corresponds to the JSON property `sessions` + # @return [Array] + attr_accessor :sessions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @sessions = args[:sessions] if args.key?(:sessions) + end + end + + # + class GoogleCloudApigeeV1ListDeploymentsResponse + include Google::Apis::Core::Hashable + + # List of deployments. + # Corresponds to the JSON property `deployments` + # @return [Array] + attr_accessor :deployments + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @deployments = args[:deployments] if args.key?(:deployments) + end + end + + # + class GoogleCloudApigeeV1ListDeveloperAppsResponse + include Google::Apis::Core::Hashable + + # List of developer apps and their credentials. + # Corresponds to the JSON property `app` + # @return [Array] + attr_accessor :app + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @app = args[:app] if args.key?(:app) + end + end + + # Response for + # ListEnvironmentResources + class GoogleCloudApigeeV1ListEnvironmentResourcesResponse + include Google::Apis::Core::Hashable + + # List of resources files. + # Corresponds to the JSON property `resourceFile` + # @return [Array] + attr_accessor :resource_file + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @resource_file = args[:resource_file] if args.key?(:resource_file) + end + end + + # + class GoogleCloudApigeeV1ListHybridIssuersResponse + include Google::Apis::Core::Hashable + + # Lists of hybrid services and its trusted issuer email ids. + # Corresponds to the JSON property `issuers` + # @return [Array] + attr_accessor :issuers + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @issuers = args[:issuers] if args.key?(:issuers) + end + end + + # + class GoogleCloudApigeeV1ListOfDevelopersResponse + include Google::Apis::Core::Hashable + + # List of developers. + # Corresponds to the JSON property `developer` + # @return [Array] + attr_accessor :developer + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @developer = args[:developer] if args.key?(:developer) + end + end + + # + class GoogleCloudApigeeV1ListOrganizationsResponse + include Google::Apis::Core::Hashable + + # List of Apigee organizations and associated GCP projects. + # Corresponds to the JSON property `organizations` + # @return [Array] + attr_accessor :organizations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @organizations = args[:organizations] if args.key?(:organizations) + end + end + + # + class GoogleCloudApigeeV1ListSharedFlowsResponse + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `sharedFlows` + # @return [Array] + attr_accessor :shared_flows + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @shared_flows = args[:shared_flows] if args.key?(:shared_flows) + end + end + + # This message type encapsulates additional information about query execution + class GoogleCloudApigeeV1Metadata + include Google::Apis::Core::Hashable + + # List of error messages as strings + # Corresponds to the JSON property `errors` + # @return [Array] + attr_accessor :errors + + # List of additional information such as data source, if result was + # truncated etc. + # E.g + # "notices": [ + # "Source:Postgres", + # "PG Host:uappg0rw.e2e.apigeeks.net", + # "query served by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed", + # "Table used: edge.api.uapgroup2.agg_api" + # ] + # Corresponds to the JSON property `notices` + # @return [Array] + attr_accessor :notices + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @errors = args[:errors] if args.key?(:errors) + @notices = args[:notices] if args.key?(:notices) + end + end + + # This message type encapsulates the metric data point + # Example + # ` + # "name": "sum(message_count)", + # "values" : [ ` + # "timestamp": 1549004400000, + # "value": "39.0" + # `, + # ` + # "timestamp" : 1548997200000, + # "value" : "0.0" + # ` ] + # ` + # or + # ` + # "name": "sum(message_count)", + # "values" : ["39.0"] + # ` + class GoogleCloudApigeeV1Metric + include Google::Apis::Core::Hashable + + # This field contains the metric name + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # List of metric values + # Possible value format + # "values":["39.0"] or + # "values":[ ` "value": "39.0", "timestamp": 1232434354` ] + # Corresponds to the JSON property `values` + # @return [Array] + attr_accessor :values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @values = args[:values] if args.key?(:values) + end + end + + # Metadata describing an Operation. + class GoogleCloudApigeeV1OperationMetadata + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `operationType` + # @return [String] + attr_accessor :operation_type + + # + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # Name of the resource for which the operation is operating on. + # Corresponds to the JSON property `targetResourceName` + # @return [String] + attr_accessor :target_resource_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @operation_type = args[:operation_type] if args.key?(:operation_type) + @state = args[:state] if args.key?(:state) + @target_resource_name = args[:target_resource_name] if args.key?(:target_resource_name) + end + end + + # + class GoogleCloudApigeeV1OptimizedStats + include Google::Apis::Core::Hashable + + # This message type encapsulates a response format for Js Optimized Scenario + # Corresponds to the JSON property `Response` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStatsResponse] + attr_accessor :response + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @response = args[:response] if args.key?(:response) + end + end + + # + class GoogleCloudApigeeV1OptimizedStatsNode + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `data` + # @return [Array] + attr_accessor :data + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @data = args[:data] if args.key?(:data) + end + end + + # This message type encapsulates a response format for Js Optimized Scenario + class GoogleCloudApigeeV1OptimizedStatsResponse + include Google::Apis::Core::Hashable + + # This field contains a list of time unit values. Time unit refers to + # an epoch timestamp value. + # Corresponds to the JSON property `TimeUnit` + # @return [Array] + attr_accessor :time_unit + + # This message type encapsulates additional information about query execution + # Corresponds to the JSON property `metaData` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Metadata] + attr_accessor :meta_data + + # This ia a boolean field to indicate if the results were truncated + # based on the limit parameter. + # Corresponds to the JSON property `resultTruncated` + # @return [Boolean] + attr_accessor :result_truncated + alias_method :result_truncated?, :result_truncated + + # This field contains a stats results + # Corresponds to the JSON property `stats` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStatsNode] + attr_accessor :stats + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @time_unit = args[:time_unit] if args.key?(:time_unit) + @meta_data = args[:meta_data] if args.key?(:meta_data) + @result_truncated = args[:result_truncated] if args.key?(:result_truncated) + @stats = args[:stats] if args.key?(:stats) + end + end + + # + class GoogleCloudApigeeV1Organization + include Google::Apis::Core::Hashable + + # Required. Primary GCP region for analytics data storage. For valid values, see + # [Create an + # organization](https://docs.apigee.com/hybrid/latest/precog-provision). + # Corresponds to the JSON property `analyticsRegion` + # @return [String] + attr_accessor :analytics_region + + # Not used by Apigee. + # Corresponds to the JSON property `attributes` + # @return [Array] + attr_accessor :attributes + + # Output only. Time that the Apigee organization was created in milliseconds + # since epoch. + # Corresponds to the JSON property `createdAt` + # @return [Fixnum] + attr_accessor :created_at + + # Not used by Apigee. + # Corresponds to the JSON property `customerName` + # @return [String] + attr_accessor :customer_name + + # Description of the Apigee organization. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Output only. List of environments in the Apigee organization. + # Corresponds to the JSON property `environments` + # @return [Array] + attr_accessor :environments + + # Output only. Time that the Apigee organization was last modified in + # milliseconds + # since epoch. + # Corresponds to the JSON property `lastModifiedAt` + # @return [Fixnum] + attr_accessor :last_modified_at + + # Required. Name of the Apigee organization. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Message for compatibility with legacy Edge specification for Java Properties + # object in JSON. + # Corresponds to the JSON property `properties` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Properties] + attr_accessor :properties + + # Output only. Runtime type of the Apigee organization based on the Apigee + # subscription + # purchased. + # Corresponds to the JSON property `runtimeType` + # @return [String] + attr_accessor :runtime_type + + # Output only. Subscription type of the Apigee organization. Valid values + # include trial + # (free, limited, and for evaluation purposes only) or paid (full + # subscription has been purchased). See + # [Apigee pricing](https://cloud.google.com/apigee/pricing/). + # Corresponds to the JSON property `subscriptionType` + # @return [String] + attr_accessor :subscription_type + + # Not used by Apigee. + # 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) + @analytics_region = args[:analytics_region] if args.key?(:analytics_region) + @attributes = args[:attributes] if args.key?(:attributes) + @created_at = args[:created_at] if args.key?(:created_at) + @customer_name = args[:customer_name] if args.key?(:customer_name) + @description = args[:description] if args.key?(:description) + @display_name = args[:display_name] if args.key?(:display_name) + @environments = args[:environments] if args.key?(:environments) + @last_modified_at = args[:last_modified_at] if args.key?(:last_modified_at) + @name = args[:name] if args.key?(:name) + @properties = args[:properties] if args.key?(:properties) + @runtime_type = args[:runtime_type] if args.key?(:runtime_type) + @subscription_type = args[:subscription_type] if args.key?(:subscription_type) + @type = args[:type] if args.key?(:type) + end + end + + # + class GoogleCloudApigeeV1OrganizationProjectMapping + include Google::Apis::Core::Hashable + + # Name of the Apigee organization. + # Corresponds to the JSON property `organization` + # @return [String] + attr_accessor :organization + + # List of GCP projects associated with the Apigee organization. + # Corresponds to the JSON property `projectIds` + # @return [Array] + attr_accessor :project_ids + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @organization = args[:organization] if args.key?(:organization) + @project_ids = args[:project_ids] if args.key?(:project_ids) + end + end + + # + class GoogleCloudApigeeV1PodStatus + include Google::Apis::Core::Hashable + + # Version of the application running in the pod. + # Corresponds to the JSON property `appVersion` + # @return [String] + attr_accessor :app_version + + # Status of the deployment. Valid values + # include: + # - `deployed`: Successful. + # - `error` : Failed. + # - `pending` : Pod has not yet reported on the deployment. + # Corresponds to the JSON property `deploymentStatus` + # @return [String] + attr_accessor :deployment_status + + # Time the deployment status was reported in milliseconds since epoch. + # Corresponds to the JSON property `deploymentStatusTime` + # @return [Fixnum] + attr_accessor :deployment_status_time + + # Time the proxy was deployed in milliseconds since epoch. + # Corresponds to the JSON property `deploymentTime` + # @return [Fixnum] + attr_accessor :deployment_time + + # Name of the pod which is reporting the status. + # Corresponds to the JSON property `podName` + # @return [String] + attr_accessor :pod_name + + # Overall status of the pod (not this specific deployment). Valid values + # include: + # - `active`: Up to date. + # - `stale` : Recently out of date. + # Pods that have not reported status in a + # long time are excluded from the output. + # Corresponds to the JSON property `podStatus` + # @return [String] + attr_accessor :pod_status + + # Time the pod status was reported in milliseconds since epoch. + # Corresponds to the JSON property `podStatusTime` + # @return [Fixnum] + attr_accessor :pod_status_time + + # Code associated with the deployment status. + # Corresponds to the JSON property `statusCode` + # @return [String] + attr_accessor :status_code + + # Human-readable message associated with the status code. + # Corresponds to the JSON property `statusCodeDetails` + # @return [String] + attr_accessor :status_code_details + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @app_version = args[:app_version] if args.key?(:app_version) + @deployment_status = args[:deployment_status] if args.key?(:deployment_status) + @deployment_status_time = args[:deployment_status_time] if args.key?(:deployment_status_time) + @deployment_time = args[:deployment_time] if args.key?(:deployment_time) + @pod_name = args[:pod_name] if args.key?(:pod_name) + @pod_status = args[:pod_status] if args.key?(:pod_status) + @pod_status_time = args[:pod_status_time] if args.key?(:pod_status_time) + @status_code = args[:status_code] if args.key?(:status_code) + @status_code_details = args[:status_code_details] if args.key?(:status_code_details) + end + end + + # Point is a group of information collected by runtime plane at critical points + # of the message flow of the processed API request. + # This is a list of supported point IDs, categorized to three major buckets. + # For each category, debug points that we are currently supporting are listed + # below: + # - Flow status debug points: + # StateChange + # FlowInfo + # Condition + # Execution + # DebugMask + # Error + # - Flow control debug points: + # FlowCallout + # Paused + # Resumed + # FlowReturn + # BreakFlow + # Error + # - Runtime debug points: + # ScriptExecutor + # FlowCalloutStepDefinition + # CustomTarget + # StepDefinition + # Oauth2ServicePoint + # RaiseFault + # NodeJS + # The detail information of the given debug point is stored in a list of + # results. + class GoogleCloudApigeeV1Point + include Google::Apis::Core::Hashable + + # Name of a step in the transaction. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # List of results extracted from a given debug point. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @results = args[:results] if args.key?(:results) + end + end + + # Message for compatibility with legacy Edge specification for Java Properties + # object in JSON. + class GoogleCloudApigeeV1Properties + include Google::Apis::Core::Hashable + + # List of all properties in the object + # Corresponds to the JSON property `property` + # @return [Array] + attr_accessor :property + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @property = args[:property] if args.key?(:property) + end + end + + # A single property entry in the Properties message. + class GoogleCloudApigeeV1Property + include Google::Apis::Core::Hashable + + # The property key + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The property value + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @value = args[:value] if args.key?(:value) + end + end + + # + class GoogleCloudApigeeV1Query + include Google::Apis::Core::Hashable + + # Delimiter used in the CSV file, if `outputFormat` is set + # to `csv`. Defaults to the `,` (comma) character. + # Supported delimiter characters include comma (`,`), pipe (`|`), + # and tab (`\t`). + # Corresponds to the JSON property `csvDelimiter` + # @return [String] + attr_accessor :csv_delimiter + + # A list of dimensions + # https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions + # Corresponds to the JSON property `dimensions` + # @return [Array] + attr_accessor :dimensions + + # Boolean expression that can be used to filter data. + # Filter expressions can be combined using AND/OR terms and should be fully + # parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and + # filters reference + # https://docs.apigee.com/api-platform/analytics/analytics-reference + # for more information on the fields available to filter + # on. For more information on the tokens that you use to build filter + # expressions, see Filter expression syntax. + # https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter- + # expression-syntax + # Corresponds to the JSON property `filter` + # @return [String] + attr_accessor :filter + + # Time unit used to group the result set. + # Valid values include: second, minute, hour, day, week, or month. + # If a query includes groupByTimeUnit, then the result is an aggregation + # based on the specified time unit and the resultant timestamp does not + # include milliseconds precision. + # If a query omits groupByTimeUnit, then the resultant timestamp includes + # milliseconds precision. + # Corresponds to the JSON property `groupByTimeUnit` + # @return [String] + attr_accessor :group_by_time_unit + + # Maximum number of rows that can be returned in the result. + # Corresponds to the JSON property `limit` + # @return [Fixnum] + attr_accessor :limit + + # A list of Metrics + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # Asynchronous Query Name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Valid values include: `csv` or `json`. Defaults to `json`. + # Note: Configure the delimiter for CSV output using the csvDelimiter + # property. + # Corresponds to the JSON property `outputFormat` + # @return [String] + attr_accessor :output_format + + # Asynchronous Report ID. + # Corresponds to the JSON property `reportDefinitionId` + # @return [String] + attr_accessor :report_definition_id + + # Required. Time range for the query. + # Can use the following predefined strings to specify the time range: + # `last60minutes` + # `last24hours` + # `last7days` + # Or, specify the timeRange as a structure describing start and end + # timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. + # Example: + # "timeRange": ` + # "start": "2018-07-29T00:13:00Z", + # "end": "2018-08-01T00:18:00Z" + # ` + # Corresponds to the JSON property `timeRange` + # @return [Object] + attr_accessor :time_range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @csv_delimiter = args[:csv_delimiter] if args.key?(:csv_delimiter) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @filter = args[:filter] if args.key?(:filter) + @group_by_time_unit = args[:group_by_time_unit] if args.key?(:group_by_time_unit) + @limit = args[:limit] if args.key?(:limit) + @metrics = args[:metrics] if args.key?(:metrics) + @name = args[:name] if args.key?(:name) + @output_format = args[:output_format] if args.key?(:output_format) + @report_definition_id = args[:report_definition_id] if args.key?(:report_definition_id) + @time_range = args[:time_range] if args.key?(:time_range) + end + end + + # + class GoogleCloudApigeeV1QueryMetadata + include Google::Apis::Core::Hashable + + # Dimensions of the AsyncQuery. + # Corresponds to the JSON property `dimensions` + # @return [Array] + attr_accessor :dimensions + + # End timestamp of the query range. + # Corresponds to the JSON property `endTimestamp` + # @return [String] + attr_accessor :end_timestamp + + # Metrics of the AsyncQuery. + # Example: ["name:message_count,func:sum,alias:sum_message_count"] + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # Output format. + # Corresponds to the JSON property `outputFormat` + # @return [String] + attr_accessor :output_format + + # Start timestamp of the query range. + # Corresponds to the JSON property `startTimestamp` + # @return [String] + attr_accessor :start_timestamp + + # Query GroupBy time unit. + # Corresponds to the JSON property `timeUnit` + # @return [String] + attr_accessor :time_unit + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @end_timestamp = args[:end_timestamp] if args.key?(:end_timestamp) + @metrics = args[:metrics] if args.key?(:metrics) + @output_format = args[:output_format] if args.key?(:output_format) + @start_timestamp = args[:start_timestamp] if args.key?(:start_timestamp) + @time_unit = args[:time_unit] if args.key?(:time_unit) + end + end + + # More info about Metric: + # https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics + class GoogleCloudApigeeV1QueryMetric + include Google::Apis::Core::Hashable + + # Alias for the metric. Alias will be used to replace metric name + # in query results. + # Corresponds to the JSON property `alias` + # @return [String] + attr_accessor :alias + + # Aggregation function: avg, min, max, or sum + # Corresponds to the JSON property `function` + # @return [String] + attr_accessor :function + + # Required. Metric name + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # One of `+`, `-`, `/`, `%`, `*` + # Corresponds to the JSON property `operator` + # @return [String] + attr_accessor :operator + + # Operand value should be provided when operator is set. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @alias = args[:alias] if args.key?(:alias) + @function = args[:function] if args.key?(:function) + @name = args[:name] if args.key?(:name) + @operator = args[:operator] if args.key?(:operator) + @value = args[:value] if args.key?(:value) + end + end + + # A Reference configuration. References must refer to a keystore + # that also exists in the parent environment. + class GoogleCloudApigeeV1Reference + include Google::Apis::Core::Hashable + + # Optional. A human-readable description of this reference. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Required. The resource id of this reference. Values must match the + # regular expression [\w\s\-.]+. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Required. The id of the resource to which this reference refers. + # Must be the id of a resource that exists in the parent environment and is + # of the given resource_type. + # Corresponds to the JSON property `refers` + # @return [String] + attr_accessor :refers + + # The type of resource referred to by this reference. Valid values + # are 'KeyStore' or 'TrustStore'. + # Corresponds to the JSON property `resourceType` + # @return [String] + attr_accessor :resource_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @name = args[:name] if args.key?(:name) + @refers = args[:refers] if args.key?(:refers) + @resource_type = args[:resource_type] if args.key?(:resource_type) + end + end + + # + class GoogleCloudApigeeV1ReferenceConfig + include Google::Apis::Core::Hashable + + # The name of the reference. Must be of the form + # 'organizations/`org`/environments/`env`/references/`ref`'. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The name of the referred resource. Only references to keystore resources + # are supported. Must be of the form + # 'organizations/`org`/environments/`env`/keystores/`ks`'. + # Corresponds to the JSON property `resourceName` + # @return [String] + attr_accessor :resource_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @resource_name = args[:resource_name] if args.key?(:resource_name) + end + end + + # + class GoogleCloudApigeeV1ReportProperty + include Google::Apis::Core::Hashable + + # name of the property + # Corresponds to the JSON property `property` + # @return [String] + attr_accessor :property + + # property values + # Corresponds to the JSON property `value` + # @return [Array] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @property = args[:property] if args.key?(:property) + @value = args[:value] if args.key?(:value) + end + end + + # + class GoogleCloudApigeeV1ResourceConfig + include Google::Apis::Core::Hashable + + # The location of the resource as a URI. + # Corresponds to the JSON property `location` + # @return [String] + attr_accessor :location + + # The resource name. Only environment-scoped resource files are supported. + # Must be of the form + # 'organizations/`org`/environments/`env`/resourcefiles/`type`/`file`/revisions/` + # rev`'. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @location = args[:location] if args.key?(:location) + @name = args[:name] if args.key?(:name) + end + end + + # Metadata about a resource file. + class GoogleCloudApigeeV1ResourceFile + include Google::Apis::Core::Hashable + + # ID of the resource file. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Resource file type. `` resource_file_type `` + # 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) + @name = args[:name] if args.key?(:name) + @type = args[:type] if args.key?(:type) + end + end + + # List of resource files. + class GoogleCloudApigeeV1ResourceFiles + include Google::Apis::Core::Hashable + + # List of resource files. + # Corresponds to the JSON property `resourceFile` + # @return [Array] + attr_accessor :resource_file + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @resource_file = args[:resource_file] if args.key?(:resource_file) + end + end + + # Result is short for "action result", could be different types identified by + # "action_result" field. Supported types: + # 1. DebugInfo : generic debug info collected by runtime recorded as a list of + # properties. For example, the contents could be virtual host info, state + # change result, or execution metadata. Required fields : properties, timestamp + # 2. RequestMessage: information of a http request. Contains headers, request + # URI and http methods type.Required fields : headers, uri, verb + # 3. ResponseMessage: information of a http response. Contains headers, reason + # phrase and http status code. Required fields : headers, reasonPhrase, + # statusCode + # 4. ErrorMessage: information of a http error message. Contains detail error + # message, reason phrase and status code. Required fields : content, headers, + # reasonPhrase, statusCode + # 5. VariableAccess: a list of variable access actions, can be Get, Set and + # Remove. Required fields : accessList + class GoogleCloudApigeeV1Result + include Google::Apis::Core::Hashable + + # Type of the action result. Can be one of the five: DebugInfo, + # RequestMessage, ResponseMessage, ErrorMessage, VariableAccess + # Corresponds to the JSON property `ActionResult` + # @return [String] + attr_accessor :action_result + + # A list of variable access actions agaist the api proxy. + # Supported values: Get, Set, Remove. + # Corresponds to the JSON property `accessList` + # @return [Array] + attr_accessor :access_list + + # Error message content. for example, + # "content" : "`\"fault\":`\"faultstring\":\"API timed + # out\",\"detail\":`\"errorcode\":\"flow.APITimedOut\"```" + # Corresponds to the JSON property `content` + # @return [String] + attr_accessor :content + + # A list of HTTP headers. + # for example, + # '"headers" : [ ` + # "name" : "Content-Length", + # "value" : "83" + # `, ` + # "name" : "Content-Type", + # "value" : "application/json" + # ` ]' + # Corresponds to the JSON property `headers` + # @return [Array] + attr_accessor :headers + + # Message for compatibility with legacy Edge specification for Java Properties + # object in JSON. + # Corresponds to the JSON property `properties` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Properties] + attr_accessor :properties + + # HTTP response phrase + # Corresponds to the JSON property `reasonPhrase` + # @return [String] + attr_accessor :reason_phrase + + # HTTP response code + # Corresponds to the JSON property `statusCode` + # @return [String] + attr_accessor :status_code + + # Timestamp of when the result is recorded. Its format is dd-mm-yy + # hh:mm:ss:xxx. For example, `"timestamp" : "12-08-19 00:31:59:960"` + # Corresponds to the JSON property `timestamp` + # @return [String] + attr_accessor :timestamp + + # The relative path of the api proxy. + # for example, `"uRI" : "/iloveapis"` + # Corresponds to the JSON property `uRI` + # @return [String] + attr_accessor :u_ri + + # HTTP method verb + # Corresponds to the JSON property `verb` + # @return [String] + attr_accessor :verb + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @action_result = args[:action_result] if args.key?(:action_result) + @access_list = args[:access_list] if args.key?(:access_list) + @content = args[:content] if args.key?(:content) + @headers = args[:headers] if args.key?(:headers) + @properties = args[:properties] if args.key?(:properties) + @reason_phrase = args[:reason_phrase] if args.key?(:reason_phrase) + @status_code = args[:status_code] if args.key?(:status_code) + @timestamp = args[:timestamp] if args.key?(:timestamp) + @u_ri = args[:u_ri] if args.key?(:u_ri) + @verb = args[:verb] if args.key?(:verb) + end + end + + # Response for Schema call + class GoogleCloudApigeeV1Schema + include Google::Apis::Core::Hashable + + # List of schema fiels grouped as dimensions. + # Corresponds to the JSON property `dimensions` + # @return [Array] + attr_accessor :dimensions + + # Additional metadata associated with schema. This is + # a legacy field and usually consists of an empty array of strings. + # Corresponds to the JSON property `meta` + # @return [Array] + attr_accessor :meta + + # List of schema fields grouped as dimensions. These are fields + # that can be used with an aggregate function such as sum, avg, min, max. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @meta = args[:meta] if args.key?(:meta) + @metrics = args[:metrics] if args.key?(:metrics) + end + end + + # Message type for the schema element + class GoogleCloudApigeeV1SchemaSchemaElement + include Google::Apis::Core::Hashable + + # Name of the field + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Message type for schema property + # Corresponds to the JSON property `properties` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SchemaSchemaProperty] + attr_accessor :properties + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @properties = args[:properties] if args.key?(:properties) + end + end + + # Message type for schema property + class GoogleCloudApigeeV1SchemaSchemaProperty + include Google::Apis::Core::Hashable + + # Creation time of the field + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Custom is a flag signifying if the field was provided as + # part of the standard dataset or a custom field created by the customer + # Corresponds to the JSON property `custom` + # @return [String] + attr_accessor :custom + + # Data type of the field. + # 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) + @create_time = args[:create_time] if args.key?(:create_time) + @custom = args[:custom] if args.key?(:custom) + @type = args[:type] if args.key?(:type) + end + end + + # + class GoogleCloudApigeeV1ServiceIssuersMapping + include Google::Apis::Core::Hashable + + # List of trusted issuer email ids. + # Corresponds to the JSON property `emailIds` + # @return [Array] + attr_accessor :email_ids + + # String indicating the Apigee service name. + # 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) + @email_ids = args[:email_ids] if args.key?(:email_ids) + @service = args[:service] if args.key?(:service) + end + end + + # Session carries the debug session id and its creation time. + class GoogleCloudApigeeV1Session + include Google::Apis::Core::Hashable + + # The debug session ID. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # The first transaction creation timestamp in millisecond, recoreded by UAP. + # Corresponds to the JSON property `timestampMs` + # @return [Fixnum] + attr_accessor :timestamp_ms + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @timestamp_ms = args[:timestamp_ms] if args.key?(:timestamp_ms) + end + end + + # The metadata describing a shared flow + class GoogleCloudApigeeV1SharedFlow + include Google::Apis::Core::Hashable + + # The id of the most recently created revision for this shared flow. + # Corresponds to the JSON property `latestRevisionId` + # @return [String] + attr_accessor :latest_revision_id + + # Metadata common to many entities in this API. + # Corresponds to the JSON property `metaData` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1EntityMetadata] + attr_accessor :meta_data + + # The ID of the shared flow. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # A list of revisions of this shared flow. + # Corresponds to the JSON property `revision` + # @return [Array] + attr_accessor :revision + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @latest_revision_id = args[:latest_revision_id] if args.key?(:latest_revision_id) + @meta_data = args[:meta_data] if args.key?(:meta_data) + @name = args[:name] if args.key?(:name) + @revision = args[:revision] if args.key?(:revision) + end + end + + # The metadata describing a shared flow revision. + class GoogleCloudApigeeV1SharedFlowRevision + include Google::Apis::Core::Hashable + + # Version of the API proxy configuration schema. Currently, only 4.0 is + # supported. + # Corresponds to the JSON property `configurationVersion` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ConfigVersion] + attr_accessor :configuration_version + + # A textual description of the shared flow revision. + # Corresponds to the JSON property `contextInfo` + # @return [String] + attr_accessor :context_info + + # Time at which this shared flow revision was created, in milliseconds since + # epoch. + # Corresponds to the JSON property `createdAt` + # @return [Fixnum] + attr_accessor :created_at + + # The human readable name of this shared flow. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # A Key-Value map of metadata about this shared flow revision. + # Corresponds to the JSON property `entityMetaDataAsProperties` + # @return [Hash] + attr_accessor :entity_meta_data_as_properties + + # Time at which this shared flow revision was most recently modified, in + # milliseconds since epoch. + # Corresponds to the JSON property `lastModifiedAt` + # @return [Fixnum] + attr_accessor :last_modified_at + + # The resource ID of the parent shared flow. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # A list of policy names included in this shared flow revision. + # Corresponds to the JSON property `policies` + # @return [Array] + attr_accessor :policies + + # List of resource files. + # Corresponds to the JSON property `resourceFiles` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFiles] + attr_accessor :resource_files + + # A list of the resources included in this shared flow revision formatted as + # "`type`://`name`". + # Corresponds to the JSON property `resources` + # @return [Array] + attr_accessor :resources + + # The resource ID of this revision. + # Corresponds to the JSON property `revision` + # @return [String] + attr_accessor :revision + + # A list of the shared flow names included in this shared flow revision. + # Corresponds to the JSON property `sharedFlows` + # @return [Array] + attr_accessor :shared_flows + + # The string "Application" + # 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) + @configuration_version = args[:configuration_version] if args.key?(:configuration_version) + @context_info = args[:context_info] if args.key?(:context_info) + @created_at = args[:created_at] if args.key?(:created_at) + @display_name = args[:display_name] if args.key?(:display_name) + @entity_meta_data_as_properties = args[:entity_meta_data_as_properties] if args.key?(:entity_meta_data_as_properties) + @last_modified_at = args[:last_modified_at] if args.key?(:last_modified_at) + @name = args[:name] if args.key?(:name) + @policies = args[:policies] if args.key?(:policies) + @resource_files = args[:resource_files] if args.key?(:resource_files) + @resources = args[:resources] if args.key?(:resources) + @revision = args[:revision] if args.key?(:revision) + @shared_flows = args[:shared_flows] if args.key?(:shared_flows) + @type = args[:type] if args.key?(:type) + end + end + + # This message type encapsulates a stats response + class GoogleCloudApigeeV1Stats + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `environments` + # @return [Array] + attr_accessor :environments + + # This message type encapsulates additional information about query execution + # Corresponds to the JSON property `metaData` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Metadata] + attr_accessor :meta_data + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @environments = args[:environments] if args.key?(:environments) + @meta_data = args[:meta_data] if args.key?(:meta_data) + end + end + + # This message type encapsulates the environment wrapper + # "environments": [ + # ` + # "metrics": [ + # ` + # "name": "sum(message_count)", + # "values": [ + # "2.52056245E8" + # ] + # ` + # ], + # "name": "prod" + # ` + # ] + class GoogleCloudApigeeV1StatsEnvironmentStats + include Google::Apis::Core::Hashable + + # This field contains the list of metrics grouped under dimensions + # Corresponds to the JSON property `dimensions` + # @return [Array] + attr_accessor :dimensions + + # In the final response, only one of the following fields will be present + # based on the dimensions provided. If no dimensions are provided, then + # only a top level metrics is provided. If dimensions are included, then + # there will be a top level dimensions field under environments which will + # contain metrics values and the dimension name. + # Example: + # "environments": [ + # ` + # "dimensions": [ + # ` + # "metrics": [ + # ` + # "name": "sum(message_count)", + # "values": [ + # "2.14049521E8" + # ] + # ` + # ], + # "name": "nit_proxy" + # ` + # ], + # "name": "prod" + # ` + # ] + # OR + # "environments": [ + # ` + # "metrics": [ + # ` + # "name": "sum(message_count)", + # "values": [ + # "2.19026331E8" + # ] + # ` + # ], + # "name": "prod" + # ` + # ] + # This field contains the list of metric values + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @metrics = args[:metrics] if args.key?(:metrics) + @name = args[:name] if args.key?(:name) + end + end + + # Pub/Sub subscription of an environment. + class GoogleCloudApigeeV1Subscription + include Google::Apis::Core::Hashable + + # Full name of the Pub/Sub subcription. Use the following structure in your + # request: + # `subscription "projects/foo/subscription/bar"` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + end + end + + # + class GoogleCloudApigeeV1SyncAuthorization + include Google::Apis::Core::Hashable + + # Entity tag (ETag) used for optimistic concurrency control as a way to help + # prevent simultaneous updates from overwriting each other. + # For example, when you call [getSyncAuthorization](getSyncAuthorization) + # an ETag is returned in the response. Pass that ETag when calling + # the [setSyncAuthorization](setSyncAuthorization) to ensure + # that you are updating the correct version. If you don't pass the + # ETag in the call to `setSyncAuthorization`, then the + # existing authorization is overwritten indiscriminately. + # **Note**: We strongly recommend that you use the ETag in the + # read-modify-write cycle to avoid race conditions. + # Corresponds to the JSON property `etag` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :etag + + # Required. Array of service accounts to grant access to control plane + # resources, each specified using the following + # format: `serviceAccount:`service-account-name. + # The service-account-name is formatted like an email address. For + # example: + # `my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount.com` + # You might specify multiple service accounts, for example, if you have + # multiple environments and wish to assign a unique service account to each + # one. + # The service accounts must have **Apigee Synchronizer Manager** role. + # See also [Create service + # accounts](https://docs.apigee.com/hybrid/latest/sa-about#create-the-service- + # accounts). + # Corresponds to the JSON property `identities` + # @return [Array] + attr_accessor :identities + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @etag = args[:etag] if args.key?(:etag) + @identities = args[:identities] if args.key?(:identities) + end + end + + # TargetServer configuration. TargetServers are used to decouple a proxy's + # TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. + class GoogleCloudApigeeV1TargetServer + include Google::Apis::Core::Hashable + + # Optional. A human-readable description of this TargetServer. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Required. The host name this target connects to. Value must be a valid + # hostname as described by RFC-1123. + # Corresponds to the JSON property `host` + # @return [String] + attr_accessor :host + + # Optional. Enabling/disabling a TargetServer is useful when TargetServers + # are used in load balancing configurations, and one or more TargetServers + # need to taken out of rotation periodically. Defaults to true. + # Corresponds to the JSON property `isEnabled` + # @return [Boolean] + attr_accessor :is_enabled + alias_method :is_enabled?, :is_enabled + + # Required. The resource id of this target server. Values must match the + # regular expression + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Required. The port number this target connects to on the given host. Value + # must be between 1 and 65535, inclusive. + # Corresponds to the JSON property `port` + # @return [Fixnum] + attr_accessor :port + + # TLS configuration information for + # VirtualHosts and + # TargetServers. + # Corresponds to the JSON property `sSLInfo` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TlsInfo] + attr_accessor :s_sl_info + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @host = args[:host] if args.key?(:host) + @is_enabled = args[:is_enabled] if args.key?(:is_enabled) + @name = args[:name] if args.key?(:name) + @port = args[:port] if args.key?(:port) + @s_sl_info = args[:s_sl_info] if args.key?(:s_sl_info) + end + end + + # + class GoogleCloudApigeeV1TargetServerConfig + include Google::Apis::Core::Hashable + + # Target host name. + # Corresponds to the JSON property `host` + # @return [String] + attr_accessor :host + + # The target server revision name. Must be of the form + # 'organizations/`org`/environments/`env`/targetservers/`ts_id`/revisions/`rev`'. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Target port. + # Corresponds to the JSON property `port` + # @return [Fixnum] + attr_accessor :port + + # TLS settings for the target. + # Corresponds to the JSON property `tlsInfo` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TlsInfoConfig] + attr_accessor :tls_info + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @host = args[:host] if args.key?(:host) + @name = args[:name] if args.key?(:name) + @port = args[:port] if args.key?(:port) + @tls_info = args[:tls_info] if args.key?(:tls_info) + end + end + + # TLS configuration information for + # VirtualHosts and + # TargetServers. + class GoogleCloudApigeeV1TlsInfo + include Google::Apis::Core::Hashable + + # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names + # listed in: + # http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames. + # html#ciphersuites + # Corresponds to the JSON property `ciphers` + # @return [Array] + attr_accessor :ciphers + + # Optional. Enables two-way TLS. + # Corresponds to the JSON property `clientAuthEnabled` + # @return [Boolean] + attr_accessor :client_auth_enabled + alias_method :client_auth_enabled?, :client_auth_enabled + + # The TLS Common Name of the certificate. + # Corresponds to the JSON property `commonName` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TlsInfoCommonName] + attr_accessor :common_name + + # Required. Enables one-way TLS. + # Corresponds to the JSON property `enabled` + # @return [Boolean] + attr_accessor :enabled + alias_method :enabled?, :enabled + + # If true, Edge ignores TLS certificate errors. Valid when configuring TLS + # for target servers and target endpoints, and when configuring virtual hosts + # that use 2-way TLS. + # When used with a target endpoint/target server, if the backend system uses + # SNI and returns a cert with a subject Distinguished Name (DN) that does not + # match the hostname, there is no way to ignore the error and the connection + # fails. + # Corresponds to the JSON property `ignoreValidationErrors` + # @return [Boolean] + attr_accessor :ignore_validation_errors + alias_method :ignore_validation_errors?, :ignore_validation_errors + + # Required if `client_auth_enabled` is true. The resource ID for the + # alias containing the private key and cert. + # Corresponds to the JSON property `keyAlias` + # @return [String] + attr_accessor :key_alias + + # Required if `client_auth_enabled` is true. The resource ID of the + # keystore. References not yet supported. + # Corresponds to the JSON property `keyStore` + # @return [String] + attr_accessor :key_store + + # The TLS versioins to be used. + # Corresponds to the JSON property `protocols` + # @return [Array] + attr_accessor :protocols + + # The resource ID of the truststore. + # References not yet supported. + # Corresponds to the JSON property `trustStore` + # @return [String] + attr_accessor :trust_store + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ciphers = args[:ciphers] if args.key?(:ciphers) + @client_auth_enabled = args[:client_auth_enabled] if args.key?(:client_auth_enabled) + @common_name = args[:common_name] if args.key?(:common_name) + @enabled = args[:enabled] if args.key?(:enabled) + @ignore_validation_errors = args[:ignore_validation_errors] if args.key?(:ignore_validation_errors) + @key_alias = args[:key_alias] if args.key?(:key_alias) + @key_store = args[:key_store] if args.key?(:key_store) + @protocols = args[:protocols] if args.key?(:protocols) + @trust_store = args[:trust_store] if args.key?(:trust_store) + end + end + + # + class GoogleCloudApigeeV1TlsInfoCommonName + include Google::Apis::Core::Hashable + + # The TLS Common Name string of the certificate. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + # Indicates whether the cert should be matched against as a wildcard cert. + # Corresponds to the JSON property `wildcardMatch` + # @return [Boolean] + attr_accessor :wildcard_match + alias_method :wildcard_match?, :wildcard_match + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @value = args[:value] if args.key?(:value) + @wildcard_match = args[:wildcard_match] if args.key?(:wildcard_match) + end + end + + # + class GoogleCloudApigeeV1TlsInfoConfig + include Google::Apis::Core::Hashable + + # Whitelist of supported ciphers. + # Corresponds to the JSON property `ciphers` + # @return [Array] + attr_accessor :ciphers + + # Indicates if client auth is enabled for the target. Enables two-way TLS. + # Corresponds to the JSON property `clientAuthEnabled` + # @return [Boolean] + attr_accessor :client_auth_enabled + alias_method :client_auth_enabled?, :client_auth_enabled + + # Common name to validate the target against. + # Corresponds to the JSON property `commonName` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CommonNameConfig] + attr_accessor :common_name + + # Enables one-way TLS. + # Corresponds to the JSON property `enabled` + # @return [Boolean] + attr_accessor :enabled + alias_method :enabled?, :enabled + + # If true, ignore TLS certificate validation errors. + # Corresponds to the JSON property `ignoreValidationErrors` + # @return [Boolean] + attr_accessor :ignore_validation_errors + alias_method :ignore_validation_errors?, :ignore_validation_errors + + # The name of the Alias used for client side auth. It must be of the form: + # organizations/`org`/environments/`env`/keystores/`keystore`/aliases/`alias` + # Corresponds to the JSON property `keyAlias` + # @return [String] + attr_accessor :key_alias + + # A pair of reference name and alias to use for client side auth. + # Corresponds to the JSON property `keyAliasReference` + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyAliasReference] + attr_accessor :key_alias_reference + + # Whitelist of supported TLS protocols. + # Corresponds to the JSON property `protocols` + # @return [Array] + attr_accessor :protocols + + # The name of the Keystore or keystore reference containing trusted + # certificates for the server. It must be of either the form + # organizations/`org`/environments/`env`/keystores/`keystore` or + # organizations/`org`/environments/`env`/references/`reference`. + # Corresponds to the JSON property `trustStore` + # @return [String] + attr_accessor :trust_store + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ciphers = args[:ciphers] if args.key?(:ciphers) + @client_auth_enabled = args[:client_auth_enabled] if args.key?(:client_auth_enabled) + @common_name = args[:common_name] if args.key?(:common_name) + @enabled = args[:enabled] if args.key?(:enabled) + @ignore_validation_errors = args[:ignore_validation_errors] if args.key?(:ignore_validation_errors) + @key_alias = args[:key_alias] if args.key?(:key_alias) + @key_alias_reference = args[:key_alias_reference] if args.key?(:key_alias_reference) + @protocols = args[:protocols] if args.key?(:protocols) + @trust_store = args[:trust_store] if args.key?(:trust_store) + 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 GoogleIamV1AuditConfig + include Google::Apis::Core::Hashable + + # The configuration for logging of each type of permission. + # Corresponds to the JSON property `auditLogConfigs` + # @return [Array] + 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 GoogleIamV1AuditLogConfig + 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] + 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 + + # Associates `members` with a `role`. + class GoogleIamV1Binding + 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::ApigeeV1::GoogleTypeExpr] + 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] + 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 + + # 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. + # Optionally, a `binding` can 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. + # **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 GoogleIamV1Policy + include Google::Apis::Core::Hashable + + # Specifies cloud audit logging configuration for this policy. + # Corresponds to the JSON property `auditConfigs` + # @return [Array] + 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] + 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. + # 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 + + # Request message for `SetIamPolicy` method. + class GoogleIamV1SetIamPolicyRequest + 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. + # Optionally, a `binding` can 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. + # **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::ApigeeV1::GoogleIamV1Policy] + 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 + + # Request message for `TestIamPermissions` method. + class GoogleIamV1TestIamPermissionsRequest + 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] + 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 GoogleIamV1TestIamPermissionsResponse + include Google::Apis::Core::Hashable + + # A subset of `TestPermissionsRequest.permissions` that the caller is + # allowed. + # Corresponds to the JSON property `permissions` + # @return [Array] + 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 response message for Operations.ListOperations. + class GoogleLongrunningListOperationsResponse + include Google::Apis::Core::Hashable + + # The standard List next-page token. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # A list of operations that matches the specified filter in the request. + # Corresponds to the JSON property `operations` + # @return [Array] + attr_accessor :operations + + 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) + @operations = args[:operations] if args.key?(:operations) + end + end + + # This resource represents a long-running operation that is the result of a + # network API call. + class GoogleLongrunningOperation + include Google::Apis::Core::Hashable + + # If the value is `false`, it means the operation is still in progress. + # If `true`, the operation is completed, and either `error` or `response` is + # available. + # Corresponds to the JSON property `done` + # @return [Boolean] + attr_accessor :done + alias_method :done?, :done + + # 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). Each `Status` message contains + # three pieces of data: error code, error message, and error details. + # You can find out more about this error model and how to work with it in the + # [API Design Guide](https://cloud.google.com/apis/design/errors). + # Corresponds to the JSON property `error` + # @return [Google::Apis::ApigeeV1::GoogleRpcStatus] + attr_accessor :error + + # Service-specific metadata associated with the operation. It typically + # contains progress information and common metadata such as create time. + # Some services might not provide such metadata. Any method that returns a + # long-running operation should document the metadata type, if any. + # Corresponds to the JSON property `metadata` + # @return [Hash] + attr_accessor :metadata + + # The server-assigned name, which is only unique within the same service that + # originally returns it. If you use the default HTTP mapping, the + # `name` should be a resource name ending with `operations/`unique_id``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The normal response of the operation in case of success. If the original + # method returns no data on success, such as `Delete`, the response is + # `google.protobuf.Empty`. If the original method is standard + # `Get`/`Create`/`Update`, the response should be the resource. For other + # methods, the response should have the type `XxxResponse`, where `Xxx` + # is the original method name. For example, if the original method name + # is `TakeSnapshot()`, the inferred response type is + # `TakeSnapshotResponse`. + # Corresponds to the JSON property `response` + # @return [Hash] + attr_accessor :response + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @done = args[:done] if args.key?(:done) + @error = args[:error] if args.key?(:error) + @metadata = args[:metadata] if args.key?(:metadata) + @name = args[:name] if args.key?(:name) + @response = args[:response] if args.key?(:response) + end + end + + # A generic empty message that you can re-use to avoid defining duplicated + # empty messages in your APIs. A typical example is to use it as the request + # or the response type of an API method. For instance: + # service Foo ` + # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); + # ` + # The JSON representation for `Empty` is empty JSON object ````. + class GoogleProtobufEmpty + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # 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). Each `Status` message contains + # three pieces of data: error code, error message, and error details. + # You can find out more about this error model and how to work with it in the + # [API Design Guide](https://cloud.google.com/apis/design/errors). + class GoogleRpcStatus + include Google::Apis::Core::Hashable + + # The status code, which should be an enum value of google.rpc.Code. + # Corresponds to the JSON property `code` + # @return [Fixnum] + attr_accessor :code + + # A list of messages that carry the error details. There is a common set of + # message types for APIs to use. + # Corresponds to the JSON property `details` + # @return [Array>] + attr_accessor :details + + # 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` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @details = args[:details] if args.key?(:details) + @message = args[:message] if args.key?(:message) + 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 GoogleTypeExpr + 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 + end + end +end diff --git a/generated/google/apis/apigee_v1/representations.rb b/generated/google/apis/apigee_v1/representations.rb new file mode 100644 index 000000000..026d5a16c --- /dev/null +++ b/generated/google/apis/apigee_v1/representations.rb @@ -0,0 +1,1944 @@ +# 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 ApigeeV1 + + class GoogleApiHttpBody + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1Access + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1AccessGet + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1AccessRemove + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1AccessSet + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1Alias + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1AliasRevisionConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ApiProduct + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ApiProductRef + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ApiProxy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ApiProxyRevision + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1App + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1AsyncQuery + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1AsyncQueryResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1AsyncQueryResultView + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1Attribute + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1Attributes + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1CertInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1Certificate + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1CommonNameConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1Company + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1CompanyApp + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1CompanyAppKey + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ConfigVersion + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1Credential + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1CustomReport + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1CustomReportMetric + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1DataLocation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1DebugMask + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1DebugSession + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1DebugSessionTransaction + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1DeleteCustomReportResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1Deployment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1DeploymentConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1Developer + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1DeveloperApp + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1DeveloperAppKey + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1DimensionMetric + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1EntityMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1Environment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1EnvironmentConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1FlowHook + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1FlowHookConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1GetSyncAuthorizationRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1KeyAliasReference + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1KeyValueMap + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1Keystore + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1KeystoreConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ListApiProductsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ListApiProxiesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ListAppsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ListAsyncQueriesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ListCompaniesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ListCompanyAppsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ListCustomReportsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ListDebugSessionsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ListDeploymentsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ListDeveloperAppsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ListEnvironmentResourcesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ListHybridIssuersResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ListOfDevelopersResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ListOrganizationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ListSharedFlowsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1Metadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1Metric + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1OperationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1OptimizedStats + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1OptimizedStatsNode + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1OptimizedStatsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1Organization + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1OrganizationProjectMapping + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1PodStatus + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1Point + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1Properties + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1Property + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1Query + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1QueryMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1QueryMetric + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1Reference + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ReferenceConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ReportProperty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ResourceConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ResourceFile + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ResourceFiles + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1Result + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1Schema + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1SchemaSchemaElement + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1SchemaSchemaProperty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1ServiceIssuersMapping + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1Session + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1SharedFlow + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1SharedFlowRevision + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1Stats + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1StatsEnvironmentStats + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1Subscription + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1SyncAuthorization + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1TargetServer + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1TargetServerConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1TlsInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1TlsInfoCommonName + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudApigeeV1TlsInfoConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleIamV1AuditConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleIamV1AuditLogConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleIamV1Binding + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleIamV1Policy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleIamV1SetIamPolicyRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleIamV1TestIamPermissionsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleIamV1TestIamPermissionsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleLongrunningListOperationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleLongrunningOperation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleProtobufEmpty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleRpcStatus + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleTypeExpr + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleApiHttpBody + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content_type, as: 'contentType' + property :data, :base64 => true, as: 'data' + collection :extensions, as: 'extensions' + end + end + + class GoogleCloudApigeeV1Access + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :get, as: 'Get', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1AccessGet, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1AccessGet::Representation + + property :remove, as: 'Remove', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1AccessRemove, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1AccessRemove::Representation + + property :set, as: 'Set', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1AccessSet, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1AccessSet::Representation + + end + end + + class GoogleCloudApigeeV1AccessGet + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :value, as: 'value' + end + end + + class GoogleCloudApigeeV1AccessRemove + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :success, as: 'success' + end + end + + class GoogleCloudApigeeV1AccessSet + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :success, as: 'success' + property :value, as: 'value' + end + end + + class GoogleCloudApigeeV1Alias + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :alias, as: 'alias' + property :certs_info, as: 'certsInfo', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Certificate, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Certificate::Representation + + property :type, as: 'type' + end + end + + class GoogleCloudApigeeV1AliasRevisionConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :location, as: 'location' + property :name, as: 'name' + property :type, as: 'type' + end + end + + class GoogleCloudApigeeV1ApiProduct + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :api_resources, as: 'apiResources' + property :approval_type, as: 'approvalType' + collection :attributes, as: 'attributes', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation + + property :created_at, :numeric_string => true, as: 'createdAt' + property :description, as: 'description' + property :display_name, as: 'displayName' + collection :environments, as: 'environments' + property :last_modified_at, :numeric_string => true, as: 'lastModifiedAt' + property :name, as: 'name' + collection :proxies, as: 'proxies' + property :quota, as: 'quota' + property :quota_interval, as: 'quotaInterval' + property :quota_time_unit, as: 'quotaTimeUnit' + collection :scopes, as: 'scopes' + end + end + + class GoogleCloudApigeeV1ApiProductRef + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :apiproduct, as: 'apiproduct' + property :status, as: 'status' + end + end + + class GoogleCloudApigeeV1ApiProxy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :latest_revision_id, as: 'latestRevisionId' + property :meta_data, as: 'metaData', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1EntityMetadata, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1EntityMetadata::Representation + + property :name, as: 'name' + collection :revision, as: 'revision' + end + end + + class GoogleCloudApigeeV1ApiProxyRevision + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :basepaths, as: 'basepaths' + property :configuration_version, as: 'configurationVersion', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ConfigVersion, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ConfigVersion::Representation + + property :context_info, as: 'contextInfo' + property :created_at, :numeric_string => true, as: 'createdAt' + property :description, as: 'description' + property :display_name, as: 'displayName' + hash :entity_meta_data_as_properties, as: 'entityMetaDataAsProperties' + property :last_modified_at, :numeric_string => true, as: 'lastModifiedAt' + property :name, as: 'name' + collection :policies, as: 'policies' + collection :proxies, as: 'proxies' + collection :proxy_endpoints, as: 'proxyEndpoints' + property :resource_files, as: 'resourceFiles', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFiles, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFiles::Representation + + collection :resources, as: 'resources' + property :revision, as: 'revision' + collection :shared_flows, as: 'sharedFlows' + property :spec, as: 'spec' + collection :target_endpoints, as: 'targetEndpoints' + collection :target_servers, as: 'targetServers' + collection :targets, as: 'targets' + collection :teams, as: 'teams' + property :type, as: 'type' + end + end + + class GoogleCloudApigeeV1App + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :api_products, as: 'apiProducts', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProductRef, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProductRef::Representation + + property :app_id, as: 'appId' + collection :attributes, as: 'attributes', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation + + property :callback_url, as: 'callbackUrl' + property :company_name, as: 'companyName' + property :created_at, :numeric_string => true, as: 'createdAt' + collection :credentials, as: 'credentials', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Credential, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Credential::Representation + + property :developer_id, as: 'developerId' + property :key_expires_in, :numeric_string => true, as: 'keyExpiresIn' + property :last_modified_at, :numeric_string => true, as: 'lastModifiedAt' + property :name, as: 'name' + collection :scopes, as: 'scopes' + property :status, as: 'status' + end + end + + class GoogleCloudApigeeV1AsyncQuery + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :created, as: 'created' + property :error, as: 'error' + property :execution_time, as: 'executionTime' + property :name, as: 'name' + property :query_params, as: 'queryParams', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1QueryMetadata, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1QueryMetadata::Representation + + property :report_definition_id, as: 'reportDefinitionId' + property :result, as: 'result', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQueryResult, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQueryResult::Representation + + property :result_file_size, as: 'resultFileSize' + property :result_rows, :numeric_string => true, as: 'resultRows' + property :self, as: 'self' + property :state, as: 'state' + property :updated, as: 'updated' + end + end + + class GoogleCloudApigeeV1AsyncQueryResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :expires, as: 'expires' + property :self, as: 'self' + end + end + + class GoogleCloudApigeeV1AsyncQueryResultView + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + property :error, as: 'error' + property :metadata, as: 'metadata', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1QueryMetadata, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1QueryMetadata::Representation + + collection :rows, as: 'rows' + property :state, as: 'state' + end + end + + class GoogleCloudApigeeV1Attribute + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :value, as: 'value' + end + end + + class GoogleCloudApigeeV1Attributes + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :attribute, as: 'attribute', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation + + end + end + + class GoogleCloudApigeeV1CertInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :basic_constraints, as: 'basicConstraints' + property :expiry_date, :numeric_string => true, as: 'expiryDate' + property :is_valid, as: 'isValid' + property :issuer, as: 'issuer' + property :public_key, as: 'publicKey' + property :serial_number, as: 'serialNumber' + property :sig_alg_name, as: 'sigAlgName' + property :subject, as: 'subject' + collection :subject_alternative_names, as: 'subjectAlternativeNames' + property :valid_from, :numeric_string => true, as: 'validFrom' + property :version, as: 'version' + end + end + + class GoogleCloudApigeeV1Certificate + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :cert_info, as: 'certInfo', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1CertInfo, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1CertInfo::Representation + + end + end + + class GoogleCloudApigeeV1CommonNameConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :match_wild_cards, as: 'matchWildCards' + property :name, as: 'name' + end + end + + class GoogleCloudApigeeV1Company + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :apps, as: 'apps' + collection :attributes, as: 'attributes', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation + + property :created_at, :numeric_string => true, as: 'createdAt' + property :display_name, as: 'displayName' + property :last_modified_at, :numeric_string => true, as: 'lastModifiedAt' + property :name, as: 'name' + property :organization, as: 'organization' + property :status, as: 'status' + end + end + + class GoogleCloudApigeeV1CompanyApp + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :api_products, as: 'apiProducts' + property :app_family, as: 'appFamily' + property :app_id, as: 'appId' + collection :attributes, as: 'attributes', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation + + property :callback_url, as: 'callbackUrl' + property :company_name, as: 'companyName' + property :created_at, :numeric_string => true, as: 'createdAt' + collection :credentials, as: 'credentials', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Credential, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Credential::Representation + + property :key_expires_in, :numeric_string => true, as: 'keyExpiresIn' + property :last_modified_at, :numeric_string => true, as: 'lastModifiedAt' + property :name, as: 'name' + collection :scopes, as: 'scopes' + property :status, as: 'status' + end + end + + class GoogleCloudApigeeV1CompanyAppKey + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :api_products, as: 'apiProducts' + collection :attributes, as: 'attributes', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation + + property :consumer_key, as: 'consumerKey' + property :consumer_secret, as: 'consumerSecret' + property :expires_at, :numeric_string => true, as: 'expiresAt' + property :issued_at, :numeric_string => true, as: 'issuedAt' + collection :scopes, as: 'scopes' + property :status, as: 'status' + end + end + + class GoogleCloudApigeeV1ConfigVersion + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :major_version, as: 'majorVersion' + property :minor_version, as: 'minorVersion' + end + end + + class GoogleCloudApigeeV1Credential + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :api_products, as: 'apiProducts', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProductRef, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProductRef::Representation + + collection :attributes, as: 'attributes', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation + + property :consumer_key, as: 'consumerKey' + property :consumer_secret, as: 'consumerSecret' + property :expires_at, :numeric_string => true, as: 'expiresAt' + property :issued_at, :numeric_string => true, as: 'issuedAt' + collection :scopes, as: 'scopes' + property :status, as: 'status' + end + end + + class GoogleCloudApigeeV1CustomReport + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :chart_type, as: 'chartType' + collection :comments, as: 'comments' + property :created_at, :numeric_string => true, as: 'createdAt' + collection :dimensions, as: 'dimensions' + property :display_name, as: 'displayName' + property :environment, as: 'environment' + property :filter, as: 'filter' + property :from_time, as: 'fromTime' + property :last_modified_at, :numeric_string => true, as: 'lastModifiedAt' + property :last_viewed_at, :numeric_string => true, as: 'lastViewedAt' + property :limit, as: 'limit' + collection :metrics, as: 'metrics', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReportMetric, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReportMetric::Representation + + property :name, as: 'name' + property :offset, as: 'offset' + property :organization, as: 'organization' + collection :properties, as: 'properties', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ReportProperty, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ReportProperty::Representation + + collection :sort_by_cols, as: 'sortByCols' + property :sort_order, as: 'sortOrder' + collection :tags, as: 'tags' + property :time_unit, as: 'timeUnit' + property :to_time, as: 'toTime' + property :topk, as: 'topk' + end + end + + class GoogleCloudApigeeV1CustomReportMetric + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :function, as: 'function' + property :name, as: 'name' + end + end + + class GoogleCloudApigeeV1DataLocation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :url, as: 'url' + end + end + + class GoogleCloudApigeeV1DebugMask + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :fault_json_paths, as: 'faultJSONPaths' + collection :fault_x_paths, as: 'faultXPaths' + property :name, as: 'name' + hash :namespaces, as: 'namespaces' + collection :request_json_paths, as: 'requestJSONPaths' + collection :request_x_paths, as: 'requestXPaths' + collection :response_json_paths, as: 'responseJSONPaths' + collection :response_x_paths, as: 'responseXPaths' + collection :variables, as: 'variables' + end + end + + class GoogleCloudApigeeV1DebugSession + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :count, as: 'count' + property :filter, as: 'filter' + property :name, as: 'name' + property :timeout, :numeric_string => true, as: 'timeout' + property :tracesize, as: 'tracesize' + property :validity, as: 'validity' + end + end + + class GoogleCloudApigeeV1DebugSessionTransaction + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :completed, as: 'completed' + collection :point, as: 'point', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Point, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Point::Representation + + end + end + + class GoogleCloudApigeeV1DeleteCustomReportResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :message, as: 'message' + end + end + + class GoogleCloudApigeeV1Deployment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :api_proxy, as: 'apiProxy' + property :base_path, as: 'basePath' + property :deploy_start_time, :numeric_string => true, as: 'deployStartTime' + property :environment, as: 'environment' + collection :pods, as: 'pods', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1PodStatus, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1PodStatus::Representation + + property :revision, as: 'revision' + end + end + + class GoogleCloudApigeeV1DeploymentConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :attributes, as: 'attributes' + property :base_path, as: 'basePath' + property :location, as: 'location' + property :name, as: 'name' + end + end + + class GoogleCloudApigeeV1Developer + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :access_type, as: 'accessType' + property :app_family, as: 'appFamily' + collection :apps, as: 'apps' + collection :attributes, as: 'attributes', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation + + collection :companies, as: 'companies' + property :created_at, :numeric_string => true, as: 'createdAt' + property :developer_id, as: 'developerId' + property :email, as: 'email' + property :first_name, as: 'firstName' + property :last_modified_at, :numeric_string => true, as: 'lastModifiedAt' + property :last_name, as: 'lastName' + property :organization_name, as: 'organizationName' + property :status, as: 'status' + property :user_name, as: 'userName' + end + end + + class GoogleCloudApigeeV1DeveloperApp + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :api_products, as: 'apiProducts' + property :app_family, as: 'appFamily' + property :app_id, as: 'appId' + collection :attributes, as: 'attributes', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation + + property :callback_url, as: 'callbackUrl' + property :created_at, :numeric_string => true, as: 'createdAt' + collection :credentials, as: 'credentials', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Credential, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Credential::Representation + + property :developer_id, as: 'developerId' + property :key_expires_in, :numeric_string => true, as: 'keyExpiresIn' + property :last_modified_at, :numeric_string => true, as: 'lastModifiedAt' + property :name, as: 'name' + collection :scopes, as: 'scopes' + property :status, as: 'status' + end + end + + class GoogleCloudApigeeV1DeveloperAppKey + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :api_products, as: 'apiProducts' + collection :attributes, as: 'attributes', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation + + property :consumer_key, as: 'consumerKey' + property :consumer_secret, as: 'consumerSecret' + property :expires_at, :numeric_string => true, as: 'expiresAt' + property :issued_at, :numeric_string => true, as: 'issuedAt' + collection :scopes, as: 'scopes' + property :status, as: 'status' + end + end + + class GoogleCloudApigeeV1DimensionMetric + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :metrics, as: 'metrics', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Metric, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Metric::Representation + + property :name, as: 'name' + end + end + + class GoogleCloudApigeeV1EntityMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :created_at, :numeric_string => true, as: 'createdAt' + property :last_modified_at, :numeric_string => true, as: 'lastModifiedAt' + property :sub_type, as: 'subType' + end + end + + class GoogleCloudApigeeV1Environment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :created_at, :numeric_string => true, as: 'createdAt' + property :description, as: 'description' + property :display_name, as: 'displayName' + property :last_modified_at, :numeric_string => true, as: 'lastModifiedAt' + property :name, as: 'name' + property :properties, as: 'properties', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Properties, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Properties::Representation + + end + end + + class GoogleCloudApigeeV1EnvironmentConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :create_time, as: 'createTime' + property :debug_mask, as: 'debugMask', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask::Representation + + collection :deployments, as: 'deployments', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeploymentConfig, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeploymentConfig::Representation + + hash :feature_flags, as: 'featureFlags' + collection :flowhooks, as: 'flowhooks', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHookConfig, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHookConfig::Representation + + collection :keystores, as: 'keystores', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeystoreConfig, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeystoreConfig::Representation + + property :name, as: 'name' + property :provider, as: 'provider' + property :pubsub_topic, as: 'pubsubTopic' + collection :resource_references, as: 'resourceReferences', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ReferenceConfig, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ReferenceConfig::Representation + + collection :resources, as: 'resources', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceConfig, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceConfig::Representation + + property :sequence_number, :numeric_string => true, as: 'sequenceNumber' + collection :targets, as: 'targets', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServerConfig, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServerConfig::Representation + + end + end + + class GoogleCloudApigeeV1FlowHook + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :continue_on_error, as: 'continueOnError' + property :description, as: 'description' + property :flow_hook_point, as: 'flowHookPoint' + property :shared_flow, as: 'sharedFlow' + end + end + + class GoogleCloudApigeeV1FlowHookConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :continue_on_error, as: 'continueOnError' + property :name, as: 'name' + property :shared_flow_name, as: 'sharedFlowName' + end + end + + class GoogleCloudApigeeV1GetSyncAuthorizationRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class GoogleCloudApigeeV1KeyAliasReference + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :alias_id, as: 'aliasId' + property :reference, as: 'reference' + end + end + + class GoogleCloudApigeeV1KeyValueMap + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :encrypted, as: 'encrypted' + property :name, as: 'name' + end + end + + class GoogleCloudApigeeV1Keystore + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :aliases, as: 'aliases' + property :name, as: 'name' + end + end + + class GoogleCloudApigeeV1KeystoreConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :aliases, as: 'aliases', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1AliasRevisionConfig, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1AliasRevisionConfig::Representation + + property :name, as: 'name' + end + end + + class GoogleCloudApigeeV1ListApiProductsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :api_product, as: 'apiProduct', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct::Representation + + end + end + + class GoogleCloudApigeeV1ListApiProxiesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :proxies, as: 'proxies', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy::Representation + + end + end + + class GoogleCloudApigeeV1ListAppsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :app, as: 'app', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1App, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1App::Representation + + end + end + + class GoogleCloudApigeeV1ListAsyncQueriesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :queries, as: 'queries', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery::Representation + + end + end + + class GoogleCloudApigeeV1ListCompaniesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :company, as: 'company', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Company, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Company::Representation + + end + end + + class GoogleCloudApigeeV1ListCompanyAppsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :app, as: 'app', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyApp, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyApp::Representation + + end + end + + class GoogleCloudApigeeV1ListCustomReportsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :qualifier, as: 'qualifier', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport::Representation + + end + end + + class GoogleCloudApigeeV1ListDebugSessionsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :sessions, as: 'sessions', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Session, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Session::Representation + + end + end + + class GoogleCloudApigeeV1ListDeploymentsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :deployments, as: 'deployments', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment::Representation + + end + end + + class GoogleCloudApigeeV1ListDeveloperAppsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :app, as: 'app', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation + + end + end + + class GoogleCloudApigeeV1ListEnvironmentResourcesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :resource_file, as: 'resourceFile', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile::Representation + + end + end + + class GoogleCloudApigeeV1ListHybridIssuersResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :issuers, as: 'issuers', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ServiceIssuersMapping, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ServiceIssuersMapping::Representation + + end + end + + class GoogleCloudApigeeV1ListOfDevelopersResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :developer, as: 'developer', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer::Representation + + end + end + + class GoogleCloudApigeeV1ListOrganizationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :organizations, as: 'organizations', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1OrganizationProjectMapping, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1OrganizationProjectMapping::Representation + + end + end + + class GoogleCloudApigeeV1ListSharedFlowsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :shared_flows, as: 'sharedFlows', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlow, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlow::Representation + + end + end + + class GoogleCloudApigeeV1Metadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :errors, as: 'errors' + collection :notices, as: 'notices' + end + end + + class GoogleCloudApigeeV1Metric + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + collection :values, as: 'values' + end + end + + class GoogleCloudApigeeV1OperationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :operation_type, as: 'operationType' + property :state, as: 'state' + property :target_resource_name, as: 'targetResourceName' + end + end + + class GoogleCloudApigeeV1OptimizedStats + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :response, as: 'Response', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStatsResponse, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStatsResponse::Representation + + end + end + + class GoogleCloudApigeeV1OptimizedStatsNode + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :data, as: 'data' + end + end + + class GoogleCloudApigeeV1OptimizedStatsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :time_unit, as: 'TimeUnit' + property :meta_data, as: 'metaData', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Metadata, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Metadata::Representation + + property :result_truncated, as: 'resultTruncated' + property :stats, as: 'stats', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStatsNode, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStatsNode::Representation + + end + end + + class GoogleCloudApigeeV1Organization + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :analytics_region, as: 'analyticsRegion' + collection :attributes, as: 'attributes' + property :created_at, :numeric_string => true, as: 'createdAt' + property :customer_name, as: 'customerName' + property :description, as: 'description' + property :display_name, as: 'displayName' + collection :environments, as: 'environments' + property :last_modified_at, :numeric_string => true, as: 'lastModifiedAt' + property :name, as: 'name' + property :properties, as: 'properties', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Properties, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Properties::Representation + + property :runtime_type, as: 'runtimeType' + property :subscription_type, as: 'subscriptionType' + property :type, as: 'type' + end + end + + class GoogleCloudApigeeV1OrganizationProjectMapping + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :organization, as: 'organization' + collection :project_ids, as: 'projectIds' + end + end + + class GoogleCloudApigeeV1PodStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :app_version, as: 'appVersion' + property :deployment_status, as: 'deploymentStatus' + property :deployment_status_time, :numeric_string => true, as: 'deploymentStatusTime' + property :deployment_time, :numeric_string => true, as: 'deploymentTime' + property :pod_name, as: 'podName' + property :pod_status, as: 'podStatus' + property :pod_status_time, :numeric_string => true, as: 'podStatusTime' + property :status_code, as: 'statusCode' + property :status_code_details, as: 'statusCodeDetails' + end + end + + class GoogleCloudApigeeV1Point + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + collection :results, as: 'results', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Result, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Result::Representation + + end + end + + class GoogleCloudApigeeV1Properties + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :property, as: 'property', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Property, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Property::Representation + + end + end + + class GoogleCloudApigeeV1Property + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :value, as: 'value' + end + end + + class GoogleCloudApigeeV1Query + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :csv_delimiter, as: 'csvDelimiter' + collection :dimensions, as: 'dimensions' + property :filter, as: 'filter' + property :group_by_time_unit, as: 'groupByTimeUnit' + property :limit, as: 'limit' + collection :metrics, as: 'metrics', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1QueryMetric, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1QueryMetric::Representation + + property :name, as: 'name' + property :output_format, as: 'outputFormat' + property :report_definition_id, as: 'reportDefinitionId' + property :time_range, as: 'timeRange' + end + end + + class GoogleCloudApigeeV1QueryMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :dimensions, as: 'dimensions' + property :end_timestamp, as: 'endTimestamp' + collection :metrics, as: 'metrics' + property :output_format, as: 'outputFormat' + property :start_timestamp, as: 'startTimestamp' + property :time_unit, as: 'timeUnit' + end + end + + class GoogleCloudApigeeV1QueryMetric + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :alias, as: 'alias' + property :function, as: 'function' + property :name, as: 'name' + property :operator, as: 'operator' + property :value, as: 'value' + end + end + + class GoogleCloudApigeeV1Reference + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :name, as: 'name' + property :refers, as: 'refers' + property :resource_type, as: 'resourceType' + end + end + + class GoogleCloudApigeeV1ReferenceConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :resource_name, as: 'resourceName' + end + end + + class GoogleCloudApigeeV1ReportProperty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :property, as: 'property' + collection :value, as: 'value', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation + + end + end + + class GoogleCloudApigeeV1ResourceConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :location, as: 'location' + property :name, as: 'name' + end + end + + class GoogleCloudApigeeV1ResourceFile + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :type, as: 'type' + end + end + + class GoogleCloudApigeeV1ResourceFiles + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :resource_file, as: 'resourceFile', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile::Representation + + end + end + + class GoogleCloudApigeeV1Result + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :action_result, as: 'ActionResult' + collection :access_list, as: 'accessList', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Access, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Access::Representation + + property :content, as: 'content' + collection :headers, as: 'headers', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Property, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Property::Representation + + property :properties, as: 'properties', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Properties, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Properties::Representation + + property :reason_phrase, as: 'reasonPhrase' + property :status_code, as: 'statusCode' + property :timestamp, as: 'timestamp' + property :u_ri, as: 'uRI' + property :verb, as: 'verb' + end + end + + class GoogleCloudApigeeV1Schema + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :dimensions, as: 'dimensions', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1SchemaSchemaElement, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1SchemaSchemaElement::Representation + + collection :meta, as: 'meta' + collection :metrics, as: 'metrics', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1SchemaSchemaElement, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1SchemaSchemaElement::Representation + + end + end + + class GoogleCloudApigeeV1SchemaSchemaElement + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :properties, as: 'properties', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1SchemaSchemaProperty, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1SchemaSchemaProperty::Representation + + end + end + + class GoogleCloudApigeeV1SchemaSchemaProperty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :create_time, as: 'createTime' + property :custom, as: 'custom' + property :type, as: 'type' + end + end + + class GoogleCloudApigeeV1ServiceIssuersMapping + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :email_ids, as: 'emailIds' + property :service, as: 'service' + end + end + + class GoogleCloudApigeeV1Session + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + property :timestamp_ms, :numeric_string => true, as: 'timestampMs' + end + end + + class GoogleCloudApigeeV1SharedFlow + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :latest_revision_id, as: 'latestRevisionId' + property :meta_data, as: 'metaData', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1EntityMetadata, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1EntityMetadata::Representation + + property :name, as: 'name' + collection :revision, as: 'revision' + end + end + + class GoogleCloudApigeeV1SharedFlowRevision + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :configuration_version, as: 'configurationVersion', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ConfigVersion, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ConfigVersion::Representation + + property :context_info, as: 'contextInfo' + property :created_at, :numeric_string => true, as: 'createdAt' + property :display_name, as: 'displayName' + hash :entity_meta_data_as_properties, as: 'entityMetaDataAsProperties' + property :last_modified_at, :numeric_string => true, as: 'lastModifiedAt' + property :name, as: 'name' + collection :policies, as: 'policies' + property :resource_files, as: 'resourceFiles', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFiles, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFiles::Representation + + collection :resources, as: 'resources' + property :revision, as: 'revision' + collection :shared_flows, as: 'sharedFlows' + property :type, as: 'type' + end + end + + class GoogleCloudApigeeV1Stats + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :environments, as: 'environments', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1StatsEnvironmentStats, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1StatsEnvironmentStats::Representation + + property :meta_data, as: 'metaData', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Metadata, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Metadata::Representation + + end + end + + class GoogleCloudApigeeV1StatsEnvironmentStats + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :dimensions, as: 'dimensions', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1DimensionMetric, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1DimensionMetric::Representation + + collection :metrics, as: 'metrics', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Metric, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Metric::Representation + + property :name, as: 'name' + end + end + + class GoogleCloudApigeeV1Subscription + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + end + end + + class GoogleCloudApigeeV1SyncAuthorization + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :etag, :base64 => true, as: 'etag' + collection :identities, as: 'identities' + end + end + + class GoogleCloudApigeeV1TargetServer + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :host, as: 'host' + property :is_enabled, as: 'isEnabled' + property :name, as: 'name' + property :port, as: 'port' + property :s_sl_info, as: 'sSLInfo', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1TlsInfo, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1TlsInfo::Representation + + end + end + + class GoogleCloudApigeeV1TargetServerConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :host, as: 'host' + property :name, as: 'name' + property :port, as: 'port' + property :tls_info, as: 'tlsInfo', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1TlsInfoConfig, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1TlsInfoConfig::Representation + + end + end + + class GoogleCloudApigeeV1TlsInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :ciphers, as: 'ciphers' + property :client_auth_enabled, as: 'clientAuthEnabled' + property :common_name, as: 'commonName', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1TlsInfoCommonName, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1TlsInfoCommonName::Representation + + property :enabled, as: 'enabled' + property :ignore_validation_errors, as: 'ignoreValidationErrors' + property :key_alias, as: 'keyAlias' + property :key_store, as: 'keyStore' + collection :protocols, as: 'protocols' + property :trust_store, as: 'trustStore' + end + end + + class GoogleCloudApigeeV1TlsInfoCommonName + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :value, as: 'value' + property :wildcard_match, as: 'wildcardMatch' + end + end + + class GoogleCloudApigeeV1TlsInfoConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :ciphers, as: 'ciphers' + property :client_auth_enabled, as: 'clientAuthEnabled' + property :common_name, as: 'commonName', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1CommonNameConfig, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1CommonNameConfig::Representation + + property :enabled, as: 'enabled' + property :ignore_validation_errors, as: 'ignoreValidationErrors' + property :key_alias, as: 'keyAlias' + property :key_alias_reference, as: 'keyAliasReference', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyAliasReference, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyAliasReference::Representation + + collection :protocols, as: 'protocols' + property :trust_store, as: 'trustStore' + end + end + + class GoogleIamV1AuditConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::ApigeeV1::GoogleIamV1AuditLogConfig, decorator: Google::Apis::ApigeeV1::GoogleIamV1AuditLogConfig::Representation + + property :service, as: 'service' + end + end + + class GoogleIamV1AuditLogConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :exempted_members, as: 'exemptedMembers' + property :log_type, as: 'logType' + end + end + + class GoogleIamV1Binding + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :condition, as: 'condition', class: Google::Apis::ApigeeV1::GoogleTypeExpr, decorator: Google::Apis::ApigeeV1::GoogleTypeExpr::Representation + + collection :members, as: 'members' + property :role, as: 'role' + end + end + + class GoogleIamV1Policy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audit_configs, as: 'auditConfigs', class: Google::Apis::ApigeeV1::GoogleIamV1AuditConfig, decorator: Google::Apis::ApigeeV1::GoogleIamV1AuditConfig::Representation + + collection :bindings, as: 'bindings', class: Google::Apis::ApigeeV1::GoogleIamV1Binding, decorator: Google::Apis::ApigeeV1::GoogleIamV1Binding::Representation + + property :etag, :base64 => true, as: 'etag' + property :version, as: 'version' + end + end + + class GoogleIamV1SetIamPolicyRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :policy, as: 'policy', class: Google::Apis::ApigeeV1::GoogleIamV1Policy, decorator: Google::Apis::ApigeeV1::GoogleIamV1Policy::Representation + + property :update_mask, as: 'updateMask' + end + end + + class GoogleIamV1TestIamPermissionsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :permissions, as: 'permissions' + end + end + + class GoogleIamV1TestIamPermissionsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :permissions, as: 'permissions' + end + end + + class GoogleLongrunningListOperationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :operations, as: 'operations', class: Google::Apis::ApigeeV1::GoogleLongrunningOperation, decorator: Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation + + end + end + + class GoogleLongrunningOperation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :done, as: 'done' + property :error, as: 'error', class: Google::Apis::ApigeeV1::GoogleRpcStatus, decorator: Google::Apis::ApigeeV1::GoogleRpcStatus::Representation + + hash :metadata, as: 'metadata' + property :name, as: 'name' + hash :response, as: 'response' + end + end + + class GoogleProtobufEmpty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class GoogleRpcStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :details, as: 'details' + property :message, as: 'message' + end + end + + class GoogleTypeExpr + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :expression, as: 'expression' + property :location, as: 'location' + property :title, as: 'title' + end + end + end + end +end diff --git a/generated/google/apis/apigee_v1/service.rb b/generated/google/apis/apigee_v1/service.rb new file mode 100644 index 000000000..2df355e89 --- /dev/null +++ b/generated/google/apis/apigee_v1/service.rb @@ -0,0 +1,6068 @@ +# 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 '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 ApigeeV1 + # Apigee API + # + # The Apigee API lets you programmatically manage Apigee hybrid with a set of + # RESTful operations, including:
  • Create, edit, and delete API proxies
  • Manage users
  • Deploy and undeploy proxy revisions
  • + # Configure environments

For information on using the APIs described + # in this section, see + # Get started using the APIs.

Note: This product is + # available as a free trial for a time period of 60 days. + # + # @example + # require 'google/apis/apigee_v1' + # + # Apigee = Google::Apis::ApigeeV1 # Alias the module + # service = Apigee::ApigeeService.new + # + # @see https://cloud.google.com/apigee-api-management/ + class ApigeeService < Google::Apis::Core::BaseService + # @return [String] + # API key. Your API key identifies your project and provides you with API access, + # quota, and reports. Required unless you provide an OAuth 2.0 token. + attr_accessor :key + + # @return [String] + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + attr_accessor :quota_user + + def initialize + super('https://apigee.googleapis.com/', '') + @batch_path = 'batch' + end + + # Lists hybrid services and its trusted issuers service account ids. + # This api is authenticated and unauthorized(allow all the users) and used by + # runtime authn-authz service to query control plane's issuer service account + # ids. + # @param [String] name + # Required. Must be of the form `hybrid/issuers`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListHybridIssuersResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListHybridIssuersResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_hybrid_issuers(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListHybridIssuersResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListHybridIssuersResponse + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates an Apigee organization. See + # [Create an + # organization](https://docs.apigee.com/hybrid/latest/precog-provision). + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization] google_cloud_apigee_v1_organization_object + # @param [String] parent + # Required. Name of the GCP project in which to associate the Apigee + # organization. + # Pass the information as a query parameter using the following structure + # in your request: + # `projects/` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_organization(google_cloud_apigee_v1_organization_object = nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/organizations', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization::Representation + command.request_object = google_cloud_apigee_v1_organization_object + command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation + command.query['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the profile for an Apigee organization. + # See + # [Organizations](https://docs.apigee.com/hybrid/latest/terminology# + # organizations). + # @param [String] name + # Required. Apigee organization name in the following format: + # `organizations/`org`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the service accounts with the permissions required to allow + # the Synchronizer to download environment data from the control plane. + # An ETag is returned in the response to `getSyncAuthorization`. + # Pass that ETag when calling [setSyncAuthorization](setSyncAuthorization) + # to ensure that you are updating the correct version. If you don't pass the + # ETag in the call to `setSyncAuthorization`, then the existing authorization + # is overwritten indiscriminately. + # For more information, see + # [Enable Synchronizer + # access](https://docs.apigee.com/hybrid/latest/synchronizer-access#enable- + # synchronizer-access). + # **Note**: Available to Apigee hybrid only. + # @param [String] name + # Required. Name of the Apigee organization. Use the following structure in your + # request: + # `organizations/`org`` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1GetSyncAuthorizationRequest] google_cloud_apigee_v1_get_sync_authorization_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_sync_authorization(name, google_cloud_apigee_v1_get_sync_authorization_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:getSyncAuthorization', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1GetSyncAuthorizationRequest::Representation + command.request_object = google_cloud_apigee_v1_get_sync_authorization_request_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the Apigee organizations and associated GCP projects that you have + # permission to access. See + # [Organizations](https://docs.apigee.com/hybrid/latest/terminology# + # organizations). + # @param [String] parent + # Required. Use the following structure in your request: + # `organizations` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOrganizationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOrganizationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organizations(parent, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOrganizationsResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOrganizationsResponse + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the permissions required to allow the Synchronizer to download + # environment data from the control plane. You must call this API to enable + # proper functioning of hybrid. + # Pass the ETag when calling `setSyncAuthorization` to ensure that + # you are updating the correct version. To get an ETag, + # call [getSyncAuthorization](getSyncAuthorization). + # If you don't pass the ETag in the call to `setSyncAuthorization`, then the + # existing authorization is overwritten indiscriminately. + # For more information, see + # [Enable Synchronizer + # access](https://docs.apigee.com/hybrid/latest/synchronizer-access#enable- + # synchronizer-access). + # **Note**: Available to Apigee hybrid only. + # @param [String] name + # Required. Name of the Apigee organization. Use the following structure in your + # request: + # `organizations/`org`` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization] google_cloud_apigee_v1_sync_authorization_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_organization_sync_authorization(name, google_cloud_apigee_v1_sync_authorization_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:setSyncAuthorization', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization::Representation + command.request_object = google_cloud_apigee_v1_sync_authorization_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the properties for an Apigee organization. No other fields in the + # organization profile will be updated. + # @param [String] name + # Required. Apigee organization name in the following format: + # `organizations/`org`` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization] google_cloud_apigee_v1_organization_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_organization(name, google_cloud_apigee_v1_organization_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v1/{+name}', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization::Representation + command.request_object = google_cloud_apigee_v1_organization_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates or creates API product attributes. This API **replaces** the + # current list of attributes with the attributes specified in the request + # body. In this way, you can update existing attributes, add new attributes, + # or delete existing attributes by omitting them from the request body. + # OAuth access tokens and Key Management Service (KMS) entities (apps, + # developers, and API products) are cached for 180 seconds (current default). + # Any custom attributes associated with entities also get cached for at least + # 180 seconds after entity is accessed during runtime. + # In this case, the `ExpiresIn` element on the OAuthV2 policy won't be able + # to expire an access token in less than 180 seconds. + # @param [String] name + # **Required.** API product name in the following form: + #

organizations/organization_ID/apiproducts/
+        #   api_product_name
+ # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] google_cloud_apigee_v1_attributes_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def attributes_organization_apiproduct(name, google_cloud_apigee_v1_attributes_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}/attributes', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation + command.request_object = google_cloud_apigee_v1_attributes_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates an API product in an organization. + # You create API products after + # you have proxied backend services using API proxies. + # An API product is a + # collection of API resources combined with quota settings and metadata that + # you can use to deliver customized and productized API bundles to your + # developer community. This metadata can include: + # - Scope + # - Environments + # - API proxies + # - Extensible profile + # API products enable you repackage APIs + # on-the-fly, without having to do any additional coding or configuration. + # Apigee recommends that you start with a simple API product including only + # required elements. You then provision credentials to apps to enable them to + # start testing your APIs. + # After you have authentication and authorization + # working against a simple API product, you can iterate to create finer + # grained API products, defining different sets of API resources for each API + # product. + # + # For more information, see ``what_api_product`` + # @param [String] parent + # Required. The parent organization name under which the API product will + # be created. Must be in the following form: + #
organizations/organization_ID
+ # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct] google_cloud_apigee_v1_api_product_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_organization_apiproduct(parent, google_cloud_apigee_v1_api_product_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/apiproducts', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct::Representation + command.request_object = google_cloud_apigee_v1_api_product_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an API product from an organization. + # Deleting an API product + # causes app requests to the resource URIs defined in the API product to + # fail. + # Ensure that you create a new API product to serve existing apps, unless + # your intention is to disable access to the resources defined in the API + # product. + # The API product name required in the request URL is the internal name of + # the product, not the display name. While they may be the same, it depends + # on whether the API product was created via the UI or the API. View the list + # of API products to verify the internal name. + # @param [String] name + # Required. API product name in the following form: + #
organizations/organization_ID/apiproducts/
+        #   api_product_name
+ # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_apiproduct(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets configuration details for an API product. + # The API product name required in the request URL is the internal name of + # the product, not the display name. While they may be the same, it depends + # on whether the API product was created via the UI or the API. View the list + # of API products to verify the internal name. + # @param [String] name + # **Required.** API product name in the following form: + #
organizations/organization_ID/apiproducts/
+        #   api_product_name
+ # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_apiproduct(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all API product names for an organization. + # Filter the list by passing an `attributename` and `attibutevalue`. + # The limit on the number of API products returned by the API is 1000. You + # can paginate the list of API products returned using the `startKey` and + # `count` query parameters. + # @param [String] parent + # **Required.** The parent organization name in the following form: + #
organizations/organization_ID
+ # @param [String] attributename + # The name of the attribute to search. + # @param [String] attributevalue + # The value of the attribute. + # @param [Fixnum] count + # Enter the number of API products you want returned in the API call. The + # limit is 1000. + # @param [Boolean] expand + # Set to `true` to get expanded details about each API. + # @param [String] start_key + # Gets a list of API products starting with a specific API product in the + # list. For example, if you're returning 50 API products at a time (using the + # `count` query parameter), you can view products 50-99 by entering the name + # of the 50th API product in the first API (without using `startKey`). + # Product name is case sensitive. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProductsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProductsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_apiproducts(parent, attributename: nil, attributevalue: nil, count: nil, expand: nil, start_key: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/apiproducts', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProductsResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProductsResponse + command.params['parent'] = parent unless parent.nil? + command.query['attributename'] = attributename unless attributename.nil? + command.query['attributevalue'] = attributevalue unless attributevalue.nil? + command.query['count'] = count unless count.nil? + command.query['expand'] = expand unless expand.nil? + command.query['startKey'] = start_key unless start_key.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing API product. You must include all required values, + # whether or not you are updating them, as well as any optional values that + # you are updating. + # The API product name required in the request URL is the + # internal name of the product, not the Display Name. While they may be the + # same, it depends on whether the API product was created via UI or API. View + # the list of API products to identify their internal names. + # @param [String] name + # **Required.** API product name in the following form: + #
organizations/organization_ID/apiproducts/
+        #   api_product_name
+ # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct] google_cloud_apigee_v1_api_product_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_organization_apiproduct(name, google_cloud_apigee_v1_api_product_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v1/{+name}', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct::Representation + command.request_object = google_cloud_apigee_v1_api_product_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an API product attribute. + # @param [String] name + # **Required.** API product name in the following form: + #
organizations/organization_ID/apiproducts/
+        #   api_product_name/attributes/attribute_name
+ # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_apiproduct_attribute(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns the value of an API product attribute. + # @param [String] name + # **Required.** API product name in the following form: + #
organizations/organization_ID/apiproducts/
+        #   api_product_name/attributes/attribute_name
+ # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_apiproduct_attribute(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns a list of all API product attributes. + # @param [String] parent + # Required. The parent organization name. Must be in the following form: + #
organizations/organization_ID/apiproducts/
+        #   api_product_name
+ # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_apiproduct_attributes(parent, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/attributes', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the value of an API product attribute. Limitations are: + # OAuth access tokens and Key Management Service (KMS) entities (apps, + # developers, and API products) are cached for 180 seconds (current default). + # Any custom attributes associated with entities also get cached for at least + # 180 seconds after entity is accessed during runtime. + # In this case, the `ExpiresIn` element on the OAuthV2 policy won't be able + # to expire an access token in less than 180 seconds. + # @param [String] name + # **Required.** API product name in the following form: + #
organizations/organization_ID/apiproducts/
+        #   api_product_name
+ # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] google_cloud_apigee_v1_attribute_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_organization_apiproduct_attribute_api_product_attribute(name, google_cloud_apigee_v1_attribute_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation + command.request_object = google_cloud_apigee_v1_attribute_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates an API proxy. + # The API proxy created will not be accessible at runtime until it is + # deployed to an environment. + # Create a new API proxy by setting the `name` query parameter to the + # name of the API proxy. + # Import an API proxy configuration bundle stored in zip format + # on your local machine to your organization by doing the following: + # * Set the `name` query parameter to the name of the API proxy. + # * Set the `action` query parameter to `import`. + # * Set the `Content-Type` header to `multipart/form-data`. + # * Pass as a file the name of API proxy + # configuration bundle stored in zip format on your local machine using + # the `file` form field. + # **Note**: To validate the API proxy configuration bundle only + # without importing it, set the `action` query + # parameter to `validate`. + # When importing an API proxy configuration bundle, if the API proxy + # does not exist, it will be created. + # If the API proxy exists, then a new revision is created. Invalid API + # proxy configurations are rejected, and a list of validation errors is + # returned to the client. + # @param [String] parent + # Required. Name of the organization in the following format: + # `organizations/`org`` + # @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object + # @param [String] action + # Action to perform when importing an API proxy configuration bundle. Set + # this parameter to one of the following values: + # * `import` to import the API proxy configuration bundle. + # * `validate` to validate the API proxy configuration bundle without + # importing it. + # @param [String] name + # Name of the API proxy. Restrict the characters used to: A-Za-z0-9._- + # @param [Boolean] validate + # Ignored. All uploads are validated regardless of the value of this + # field. Maintained for compatibility with Apigee Edge API. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_organization_api(parent, google_api_http_body_object = nil, action: nil, name: nil, validate: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/apis', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation + command.request_object = google_api_http_body_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision + command.params['parent'] = parent unless parent.nil? + command.query['action'] = action unless action.nil? + command.query['name'] = name unless name.nil? + command.query['validate'] = validate unless validate.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an API proxy and all associated endpoints, policies, resources, and + # revisions. The API proxy must be undeployed before you can delete it. + # @param [String] name + # Required. Name of the API proxy in the following format: + # `organizations/`org`/apis/`api`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_api(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets an API proxy including a list of existing revisions. + # @param [String] name + # Required. Name of the API proxy in the following format: + # `organizations/`org`/apis/`api`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_api(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the names of all API proxies in an organization. The names returned + # correspond to the names defined in the configuration files for each API + # proxy. + # @param [String] parent + # Required. Name of the organization in the following format: + # `organizations/`org`` + # @param [Boolean] include_meta_data + # Flag that specifies whether to include API proxy metadata in the response. + # @param [Boolean] include_revisions + # Flag that specifies whether to include a list of revisions in the response. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProxiesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProxiesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_apis(parent, include_meta_data: nil, include_revisions: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/apis', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProxiesResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProxiesResponse + command.params['parent'] = parent unless parent.nil? + command.query['includeMetaData'] = include_meta_data unless include_meta_data.nil? + command.query['includeRevisions'] = include_revisions unless include_revisions.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all deployments of an API proxy. + # @param [String] parent + # Required. Name of the API proxy for which to return deployment information in + # the + # following format: + # `organizations/`org`/apis/`api`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_api_deployments(parent, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/deployments', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a key value map in an api proxy. + # @param [String] parent + # Required. The name of the environment in which to create the key value map. + # Must be of the form + # `organizations/`organization`/apis/`api``. + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] google_cloud_apigee_v1_key_value_map_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_organization_api_keyvaluemap(parent, google_cloud_apigee_v1_key_value_map_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/keyvaluemaps', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation + command.request_object = google_cloud_apigee_v1_key_value_map_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Delete a key value map in an api proxy. + # @param [String] name + # Required. The name of the key value map. + # Must be of the form + # `organizations/`organization`/apis/`api`/keyvaluemaps/`keyvaluemap``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_api_keyvaluemap(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an API proxy revision and all policies, resources, endpoints, + # and revisions associated with it. The API proxy revision must be undeployed + # before you can delete it. + # @param [String] name + # Required. API proxy revision in the following format: + # `organizations/`org`/apis/`api`/revisions/`rev`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_api_revision(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets an API proxy revision. + # To download the API proxy configuration bundle for the specified revision + # as a zip file, do the following: + # * Set the `format` query parameter to `bundle`. + # * Set the `Accept` header to `application/zip`. + # If you are using curl, specify `-o filename.zip` to save the output to a + # file; otherwise, it displays to `stdout`. Then, develop the API proxy + # configuration locally and upload the updated API proxy configuration + # revision, as described in + # [updateApiProxyRevision](updateApiProxyRevision). + # @param [String] name + # Required. API proxy revision in the following format: + # `organizations/`org`/apis/`api`/revisions/`rev`` + # @param [String] format + # Format used when downloading the API proxy configuration revision. + # Set to `bundle` to download the API proxy configuration revision as a zip + # file. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleApiHttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleApiHttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_api_revision(name, format: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleApiHttpBody + command.params['name'] = name unless name.nil? + command.query['format'] = format unless format.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing API proxy revision by uploading the API proxy + # configuration bundle as a zip file from your local machine. + # You can update only API proxy revisions + # that have never been deployed. After deployment, an API proxy revision + # becomes immutable, even if it is undeployed. + # Set the `Content-Type` header to either + # `multipart/form-data` or `application/octet-stream`. + # @param [String] name + # Required. API proxy revision to update in the following format: + # `organizations/`org`/apis/`api`/revisions/`rev`` + # @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object + # @param [Boolean] validate + # Ignored. All uploads are validated regardless of the value of this field. + # Maintained for compatibility with Apigee Edge API. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_organization_api_revision_api_proxy_revision(name, google_api_http_body_object = nil, validate: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation + command.request_object = google_api_http_body_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision + command.params['name'] = name unless name.nil? + command.query['validate'] = validate unless validate.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all deployments of an API proxy revision. + # @param [String] parent + # Required. Name of the API proxy revision for which to return deployment + # information + # in the following format: + # `organizations/`org`/apis/`api`/revisions/`rev``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_api_revision_deployments(parent, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/deployments', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the app profile for the specified app ID. + # @param [String] name + # Required. App ID in the following format: + # `organizations/`org`/apps/`app`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1App] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1App] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_app(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1App::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1App + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists IDs of apps within an organization that have the specified app status + # (approved or revoked) or are of the specified app type + # (developer or company). + # @param [String] parent + # Required. Resource path of the parent in the following format: + # `organizations/`org`` + # @param [String] api_product + # API product. + # @param [String] apptype + # Optional. Filter by the type of the app. Valid values are `company` or + # `developer`. Defaults to `developer`. + # @param [Boolean] expand + # Optional. Flag that specifies whether to return an expanded list of + # apps for the organization. Defaults to `false`. + # @param [String] ids + # Optional. Comma-separated list of app IDs on which to filter. + # @param [Boolean] include_cred + # Optional. Flag that specifies whether to include credentials in the + # response. + # @param [String] key_status + # Optional. Key status of the app. Valid values include `approved` or + # `revoked`. Defaults to `approved`. + # @param [Fixnum] rows + # Optional. Maximum number of app IDs to return. Defaults to 10000. + # @param [String] start_key + # Returns the list of apps starting from the specified app ID. + # @param [String] status + # Optional. Filter by the status of the app. Valid values are `approved` + # or `revoked`. Defaults to `approved`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_apps(parent, api_product: nil, apptype: nil, expand: nil, ids: nil, include_cred: nil, key_status: nil, rows: nil, start_key: nil, status: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/apps', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppsResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppsResponse + command.params['parent'] = parent unless parent.nil? + command.query['apiProduct'] = api_product unless api_product.nil? + command.query['apptype'] = apptype unless apptype.nil? + command.query['expand'] = expand unless expand.nil? + command.query['ids'] = ids unless ids.nil? + command.query['includeCred'] = include_cred unless include_cred.nil? + command.query['keyStatus'] = key_status unless key_status.nil? + command.query['rows'] = rows unless rows.nil? + command.query['startKey'] = start_key unless start_key.nil? + command.query['status'] = status unless status.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates an app for a company. Note that you must first create a profile + # for the company in your organization before you can register apps that + # are associated with the company. + # @param [String] parent + # Name of org that the company will be created in + # ``parent=organizations/*`` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Company] google_cloud_apigee_v1_company_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Company] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Company] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_organization_company(parent, google_cloud_apigee_v1_company_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/companies', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Company::Representation + command.request_object = google_cloud_apigee_v1_company_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Company::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Company + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an existing company. + # @param [String] name + # The company resource name + # `organizations/`org`/companies/`company`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Company] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Company] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_company(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Company::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Company + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # List details for a company. + # @param [String] name + # The company resource name + # `organizations/`org`/companies/`company`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Company] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Company] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_company(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Company::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Company + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # List all companies in an organization, and optionally returns an + # expanded list of companies, displaying a full profile for each company in + # the organization. + # @param [String] parent + # The parent organization name + # `organizations/`org`` + # @param [Fixnum] count + # Limits the list to the number you specify. The limit is 100. + # @param [Boolean] expand + # Set expand to true to return a full profile for each company. + # @param [Boolean] include_developers + # Optional. include developers in the response. + # @param [String] start_key + # To filter the keys that are returned, enter the email of a developer + # that the list will start with. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListCompaniesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListCompaniesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_companies(parent, count: nil, expand: nil, include_developers: nil, start_key: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/companies', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListCompaniesResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListCompaniesResponse + command.params['parent'] = parent unless parent.nil? + command.query['count'] = count unless count.nil? + command.query['expand'] = expand unless expand.nil? + command.query['includeDevelopers'] = include_developers unless include_developers.nil? + command.query['startKey'] = start_key unless start_key.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing company. + # Send the complete company record as a payload with any changes you want to + # make. Note that to change the status of the Company you use Set the Status + # of a Company. The attributes in the sample payload below apply to company + # configuration in monetization. For non-monetized companies, you need send + # only displayName. + # @param [String] name + # Name of the company to be updated. + # ``name=organizations/*/companies/*`` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Company] google_cloud_apigee_v1_company_object + # @param [String] action + # Specify the status as active or inactive. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Company] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Company] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_organization_company(name, google_cloud_apigee_v1_company_object = nil, action: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v1/{+name}', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Company::Representation + command.request_object = google_cloud_apigee_v1_company_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Company::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Company + command.params['name'] = name unless name.nil? + command.query['action'] = action unless action.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates an app for a company. + # @param [String] parent + # Resource path of the parent: `organizations/`org`/companies/`company_name`` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyApp] google_cloud_apigee_v1_company_app_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyApp] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyApp] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_organization_company_app(parent, google_cloud_apigee_v1_company_app_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/apps', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyApp::Representation + command.request_object = google_cloud_apigee_v1_company_app_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyApp::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyApp + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a company app. + # @param [String] name + # name of the app resource: + # `organizations/`org`/companies/`company_name`/apps/`app_name`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyApp] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyApp] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_company_app(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyApp::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyApp + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the profile of a specific company app. + # @param [String] name + # name of the app resource: + # `organizations/`org`/companies/`company_name`/apps/`app_name`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyApp] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyApp] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_company_app(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyApp::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyApp + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # List company apps in an organization. You can optionally expand the + # response to include the profile for each app. + # @param [String] parent + # The name of a company resource: + # `organizations/`org`/companies/`company_name`` + # @param [Fixnum] count + # Limits the list to the number you specify. The limit is 100. + # @param [Boolean] expand + # Set expand to true to return a full profile + # @param [String] start_key + # Lets you return a list of app starting with a specific app name in the + # list. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListCompanyAppsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListCompanyAppsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_company_apps(parent, count: nil, expand: nil, start_key: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/apps', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListCompanyAppsResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListCompanyAppsResponse + command.params['parent'] = parent unless parent.nil? + command.query['count'] = count unless count.nil? + command.query['expand'] = expand unless expand.nil? + command.query['startKey'] = start_key unless start_key.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing company app. + # @param [String] name + # Resource path of the app: + # `organizations/`org`/companies/`company_name`/apps/`app_name`` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyApp] google_cloud_apigee_v1_company_app_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyApp] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyApp] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_organization_company_app(name, google_cloud_apigee_v1_company_app_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v1/{+name}', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyApp::Representation + command.request_object = google_cloud_apigee_v1_company_app_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyApp::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyApp + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a key for a company app and removes all API products associated + # with the app. The key can no longer be used to access any APIs. + # @param [String] name + # Resource name of a company app key + # `organizations/`org`/companies/`company`/apps/`app`/keys/`key`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyAppKey] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyAppKey] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_company_app_key(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyAppKey::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyAppKey + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets information about the consumer key issued to a specific company app. + # @param [String] name + # Resource name of a company app key + # `organizations/`org`/companies/`company`/apps/`app`/keys/`key`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyAppKey] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyAppKey] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_company_app_key(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyAppKey::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyAppKey + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing company app key to add additional API products or + # attributes. Note that only a single API product can be resolved per app + # key at runtime. API products are resolved by name, in alphabetical order. + # The first API product found in the list will be returned. + # @param [String] name + # Resource name of a company app key + # `organizations/`org`/companies/`company`/apps/`app`/keys/`key`` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyAppKey] google_cloud_apigee_v1_company_app_key_object + # @param [String] action + # Set action to approve or revoke. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyAppKey] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyAppKey] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_organization_company_app_key_company_app_key(name, google_cloud_apigee_v1_company_app_key_object = nil, action: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyAppKey::Representation + command.request_object = google_cloud_apigee_v1_company_app_key_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyAppKey::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CompanyAppKey + command.params['name'] = name unless name.nil? + command.query['action'] = action unless action.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all deployments of API proxies or shared flows. + # @param [String] parent + # Required. Name of the organization for which to return deployment information + # in the + # following format: + # `organizations/`org`` + # @param [Boolean] shared_flows + # Optional. Flag that specifies whether to return shared flow or API proxy + # deployments. + # Set to `true` to return shared flow deployments; set to `false` + # to return API proxy deployments. Defaults to `false`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_deployments(parent, shared_flows: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/deployments', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse + command.params['parent'] = parent unless parent.nil? + command.query['sharedFlows'] = shared_flows unless shared_flows.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates developer attributes. + # This API replaces the + # existing attributes with those specified in the request. + # Add new attributes, and include or exclude any existing + # attributes that you want to retain or + # remove, respectively. + # The custom attribute limit is 18. + # **Note**: OAuth access tokens and Key Management Service (KMS) entities + # (apps, developers, and API products) are cached for 180 seconds + # (default). Any custom attributes associated with these entities + # are cached for at least 180 seconds after the entity is accessed at + # runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy + # won't be able to expire an access token in less than 180 seconds. + # @param [String] parent + # Required. Email address of the developer for which attributes are being + # updated in + # the following format: + # `organizations/`org`/developers/`developer_email`` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] google_cloud_apigee_v1_attributes_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def attributes_organization_developer(parent, google_cloud_apigee_v1_attributes_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/attributes', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation + command.request_object = google_cloud_apigee_v1_attributes_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a developer. Once created, + # the developer can register an app and obtain an API key. + # At creation time, a developer is set as `active`. To change the developer + # status, use the SetDeveloperStatus API. + # @param [String] parent + # Required. Name of the Apigee organization in which the developer is created. + # Use the following structure in your request: + # `organizations/`org``. + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer] google_cloud_apigee_v1_developer_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_organization_developer(parent, google_cloud_apigee_v1_developer_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/developers', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer::Representation + command.request_object = google_cloud_apigee_v1_developer_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a developer. All apps and API keys associated + # with the developer are also removed. + # **Warning**: This API will permanently delete the developer + # and related artifacts. + # To avoid permanently deleting developers and their artifacts, + # set the developer status to `inactive` using + # the SetDeveloperStatus API. + # **Note**: The delete operation is asynchronous. The developer app is + # deleted immediately, + # but its associated resources, such as apps and API keys, may take anywhere + # from a few seconds to a few minutes to be deleted. + # @param [String] name + # Required. Email address of the developer. Use the following structure in your + # request: + # `organizations/`org`/developers/`developer_email`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_developer(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns the developer details, including the + # developer's name, email address, apps, and other information. + # **Note**: The response includes only the first 100 developer apps. + # @param [String] name + # Required. Email address of the developer. Use the following structure in your + # request: + # `organizations/`org`/developers/`developer_email`` + # @param [String] action + # Status of the developer. Valid values are `active` or `inactive`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_developer(name, action: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer + command.params['name'] = name unless name.nil? + command.query['action'] = action unless action.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all developers in an organization by email address. + # By default, + # the response does not include company developers. Set the `includeCompany` + # query parameter to `true` to include company developers. + # **Note**: A maximum of 1000 developers are returned in the response. You + # paginate the list of developers returned using the `startKey` and `count` + # query parameters. + # @param [String] parent + # Required. Name of the Apigee organization. Use the following structure in your + # request: + # `organizations/`org``. + # @param [Fixnum] count + # Optional. Number of developers to return in the API call. Use with the ` + # startKey` + # parameter to provide more targeted filtering. + # The limit is 1000. + # @param [Boolean] expand + # Specifies whether to expand the results. Set to `true` + # to expand the results. This query parameter is not valid if you use + # the `count` or `startKey` query parameters. + # @param [String] ids + # Optional. List of IDs to include, separated by commas. + # @param [Boolean] include_company + # Flag that specifies whether to include company details in the response. + # @param [String] start_key + # **Note**: Must be used in conjunction with the `count` parameter. + # Email address of the developer from which to start displaying the list of + # developers. For example, if the an unfiltered list returns: + # ``` + # westley@example.com + # fezzik@example.com + # buttercup@example.com + # ``` + # and your `startKey` is `fezzik@example.com`, the list returned will be + # ``` + # fezzik@example.com + # buttercup@example.com + # ``` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOfDevelopersResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOfDevelopersResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_developers(parent, count: nil, expand: nil, ids: nil, include_company: nil, start_key: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/developers', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOfDevelopersResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOfDevelopersResponse + command.params['parent'] = parent unless parent.nil? + command.query['count'] = count unless count.nil? + command.query['expand'] = expand unless expand.nil? + command.query['ids'] = ids unless ids.nil? + command.query['includeCompany'] = include_company unless include_company.nil? + command.query['startKey'] = start_key unless start_key.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the status of a developer. Valid values are `active` or `inactive`. + # A developer is `active` by default. If you set a developer's status to + # `inactive`, the API keys assigned to the developer apps are no longer valid + # even though the API keys are set to `approved`. Inactive developers + # can still sign in to the developer portal and create apps; however, any + # new API keys generated during app creation won't work. + # If successful, the API call returns the + # following HTTP status code: `204 No Content` + # @param [String] name + # Required. Email address of the developer. Use the following structure in your + # request: + # `organizations/`org`/developers/`developer_email`` + # @param [String] action + # Status of the developer. Valid values are `active` and `inactive`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleProtobufEmpty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleProtobufEmpty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_organization_developer_developer_status(name, action: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty + command.params['name'] = name unless name.nil? + command.query['action'] = action unless action.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates a developer. + # This API replaces the existing developer details with those specified + # in the request. Include or exclude any existing details that + # you want to retain or delete, respectively. + # The custom attribute limit is 18. + # **Note**: OAuth access tokens and Key Management Service (KMS) entities + # (apps, developers, and API products) are cached for 180 seconds + # (current default). Any custom attributes associated with these entities + # are cached for at least 180 seconds after the entity is accessed at + # runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy + # won't be able to expire an access token in less than 180 seconds. + # @param [String] name + # Required. Email address of the developer. Use the following structure in your + # request: + # `organizations/`org`/developers/`developer_email`` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer] google_cloud_apigee_v1_developer_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_organization_developer(name, google_cloud_apigee_v1_developer_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v1/{+name}', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer::Representation + command.request_object = google_cloud_apigee_v1_developer_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates attributes for a developer app. This API replaces the + # current attributes with those specified in the request. + # @param [String] name + # Required. Name of the developer app. Use the following structure in your + # request: + # `organizations/`org`/developers/`developer_email`/apps/`app`` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] google_cloud_apigee_v1_attributes_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def attributes_organization_developer_app(name, google_cloud_apigee_v1_attributes_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}/attributes', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation + command.request_object = google_cloud_apigee_v1_attributes_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates an app associated with a developer. This API associates the + # developer app with the specified API + # product and auto-generates an API key for the app to use in calls to API + # proxies inside that API product. + # The `name` is the unique ID of the app + # that you can use in API calls. The `DisplayName` (set as an + # attribute) appears in the UI. If you don't set the + # `DisplayName` attribute, the `name` appears in the UI. + # @param [String] parent + # Required. Name of the developer. Use the following structure in your request: + # `organizations/`org`/developers/`developer_email`` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] google_cloud_apigee_v1_developer_app_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_organization_developer_app(parent, google_cloud_apigee_v1_developer_app_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/apps', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation + command.request_object = google_cloud_apigee_v1_developer_app_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a developer app. + # **Note**: The delete operation is asynchronous. The developer app is + # deleted immediately, + # but its associated resources, such as app + # keys or access tokens, may take anywhere from a few seconds to a + # few minutes to be deleted. + # @param [String] name + # Required. Name of the developer app. Use the following structure in your + # request: + # `organizations/`org`/developers/`developer_email`/apps/`app`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_developer_app(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Manages access to a developer app by enabling you to: + # * Approve or revoke a developer app + # * Generate a new consumer key and secret for a developer app + # To approve or revoke a developer app, set the `action` query parameter to + # `approved` or `revoked`, respectively, and the + # `Content-Type` header to `application/octet-stream`. If a developer app is + # revoked, none of its API keys are valid for API calls even though + # the keys are still `approved`. If successful, the API call returns the + # following HTTP status code: `204 No Content` + # To generate a new consumer key and secret for a developer + # app, pass the new key/secret details. Rather than + # replace an existing key, this API generates a new + # key. In this case, multiple key + # pairs may be associated with a single developer app. Each key pair has an + # independent status (`approved` or `revoked`) and expiration time. + # Any approved, non-expired key can be used in an API call. + # For example, if you're using API key rotation, you can generate new + # keys with expiration times that overlap keys that are going to expire. + # You might also generate a new consumer key/secret if the security of the + # original key/secret is compromised. + # The `keyExpiresIn` property defines the + # expiration time for the API key in milliseconds. If you don't set + # this property or set it to `-1`, the API key never expires. + # **Notes**: + # * When generating a new key/secret, this API replaces the + # existing attributes, notes, and callback URLs with those specified in the + # request. Include or exclude any existing information that you want to + # retain or delete, respectively. + # * To migrate existing consumer keys and secrets to hybrid from another + # system, see the + # CreateDeveloperAppKey API. + # @param [String] name + # Required. Name of the developer app. Use the following structure in your + # request: + # `organizations/`org`/developers/`developer_email`/apps/`app`` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] google_cloud_apigee_v1_developer_app_object + # @param [String] action + # Action. Valid values are `approve` or `revoke`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def generate_organization_developer_app_key_pair_or_update_developer_app_status(name, google_cloud_apigee_v1_developer_app_object = nil, action: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation + command.request_object = google_cloud_apigee_v1_developer_app_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp + command.params['name'] = name unless name.nil? + command.query['action'] = action unless action.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns the details for a developer app. + # @param [String] name + # Required. Name of the developer app. Use the following structure in your + # request: + # `organizations/`org`/developers/`developer_email`/apps/`app`` + # @param [String] entity + # **Note**: Must be used in conjunction with the `query` parameter. + # Set to `apiresources` + # to return the number of API resources + # that have been approved for access by a developer app in the + # specified Apigee organization. + # @param [String] query + # **Note**: Must be used in conjunction with the `entity` parameter. + # Set to `count` to return the number of API resources + # that have been approved for access by a developer app in the + # specified Apigee organization. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_developer_app(name, entity: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp + command.params['name'] = name unless name.nil? + command.query['entity'] = entity unless entity.nil? + command.query['query'] = query unless query.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all apps created by a developer in an Apigee organization. + # Optionally, you can request an expanded view of the developer apps. + # A maximum of 100 developer apps are returned per API call. You can paginate + # the list of deveoper apps returned using the `startKey` and `count` query + # parameters. + # @param [String] parent + # Required. Name of the developer. Use the following structure in your request: + # `organizations/`org`/developers/`developer_email`` + # @param [Fixnum] count + # Number of developer apps to return in the API call. Use with the `startKey` + # parameter to provide more targeted filtering. + # The limit is 1000. + # @param [Boolean] expand + # Optional. Specifies whether to expand the results. Set to `true` + # to expand the results. This query parameter is not valid if you use + # the `count` or `startKey` query parameters. + # @param [Boolean] shallow_expand + # Optional. Specifies whether to expand the results in shallow mode. + # Set to `true` to expand the results in shallow mode. + # @param [String] start_key + # **Note**: Must be used in conjunction with the `count` parameter. + # Name of the developer app from which to start displaying the list of + # developer apps. For example, if you're returning 50 developer apps at + # a time (using the `count` query parameter), you can view developer apps + # 50-99 by entering the name of the 50th developer app. + # The developer app name is case sensitive. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperAppsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperAppsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_developer_apps(parent, count: nil, expand: nil, shallow_expand: nil, start_key: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/apps', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperAppsResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperAppsResponse + command.params['parent'] = parent unless parent.nil? + command.query['count'] = count unless count.nil? + command.query['expand'] = expand unless expand.nil? + command.query['shallowExpand'] = shallow_expand unless shallow_expand.nil? + command.query['startKey'] = start_key unless start_key.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the details for a developer app. In addition, you can + # add an API product to a developer app and automatically generate + # an API key for the app to use when calling APIs in the API product. + # If you want to use an existing API key for the API product, + # add the API product to the API key using the + # UpdateDeveloperAppKey + # API. + # Using this API, you cannot update the following: + # * App name as it is the primary key used to identify the app and cannot + # be changed. + # * Scopes associated with the app. Instead, use the + # ReplaceDeveloperAppKey API. + # This API replaces the + # existing attributes with those specified in the request. + # Include or exclude any existing attributes that you want to retain or + # delete, respectively. + # @param [String] name + # Required. Name of the developer app. Use the following structure in your + # request: + # `organizations/`org`/developers/`developer_email`/apps/`app`` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] google_cloud_apigee_v1_developer_app_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_organization_developer_app(name, google_cloud_apigee_v1_developer_app_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v1/{+name}', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation + command.request_object = google_cloud_apigee_v1_developer_app_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a developer app attribute. + # @param [String] name + # Required. Name of the developer app attribute. Use the following structure in + # your + # request: + # `organizations/`org`/developers/`developer_email`/apps/`app`/attributes/` + # attribute`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_developer_app_attribute(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns a developer app attribute. + # @param [String] name + # Required. Name of the developer app attribute. Use the following structure in + # your + # request: + # `organizations/`org`/developers/`developer_email`/apps/`app`/attributes/` + # attribute`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_developer_app_attribute(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns a list of all developer app attributes. + # @param [String] parent + # Required. Name of the developer app. Use the following structure in your + # request: + # `organizations/`org`/developers/`developer_email`/apps/`app`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_developer_app_attributes(parent, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/attributes', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates a developer app attribute. + # **Note**: OAuth access tokens and Key Management Service (KMS) entities + # (apps, developers, and API products) are cached for 180 seconds + # (current default). Any custom attributes associated with these entities + # are cached for at least 180 seconds after the entity is accessed at + # runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy + # won't be able to expire an access token in less than 180 seconds. + # @param [String] name + # Required. Name of the developer app attribute. Use the following structure in + # your + # request: + # `organizations/`org`/developers/`developer_email`/apps/`app`/attributes/` + # attribute`` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] google_cloud_apigee_v1_attribute_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_organization_developer_app_attribute_developer_app_attribute(name, google_cloud_apigee_v1_attribute_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation + command.request_object = google_cloud_apigee_v1_attribute_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a custom consumer key and secret for a developer app. This is + # particularly useful if you want to migrate existing consumer keys and + # secrets to Apigee hybrid from another system. + # Consumer keys and secrets can contain letters, numbers, underscores, and + # hyphens. No other special characters are allowed. + # **Note**: To avoid service disruptions, a consumer key and secret + # should not exceed 2 KBs each. + # After creating the consumer key and secret, associate the key with + # an API product using the + # UpdateDeveloperAppKey API. + # If a consumer key and secret already exist, you can keep them or + # delete them using the + # DeleteDeveloperAppKey API. + # @param [String] parent + # Parent of the developer app key. Use the following structure in your + # request: + # `organizations/`org`/developers/`developer_email`/apps` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] google_cloud_apigee_v1_developer_app_key_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_organization_developer_app_key(parent, google_cloud_apigee_v1_developer_app_key_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/keys', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation + command.request_object = google_cloud_apigee_v1_developer_app_key_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an app's consumer key and removes all API products + # associated with the app. After the consumer key is deleted, + # it cannot be used to access any APIs. + # **Note**: After you delete a consumer key, you may want to: + # 1. Create a new consumer key and secret for the developer app using the + # CreateDeveloperAppKey API, and + # subsequently add an API product to the key using the + # UpdateDeveloperAppKey API. + # 2. Delete the developer app, if it is no longer required. + # @param [String] name + # Name of the developer app key. Use the following structure in your request: + # `organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_developer_app_key(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns details for a consumer key for a developer app, including the key + # and secret value, associated API products, and other information. + # @param [String] name + # Name of the developer app key. Use the following structure in your request: + # `organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_developer_app_key(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the scope of an app. + # This API replaces the + # existing scopes with those specified in the request. + # Include or exclude any existing scopes that you want to retain or + # delete, respectively. The specified scopes must already + # be defined for the API products associated with the app. + # This API sets the `scopes` element + # under the `apiProducts` element in the attributes of the app. + # @param [String] name + # Name of the developer app key. Use the following structure in your request: + # `organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key`` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] google_cloud_apigee_v1_developer_app_key_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def replace_organization_developer_app_key_developer_app_key(name, google_cloud_apigee_v1_developer_app_key_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v1/{+name}', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation + command.request_object = google_cloud_apigee_v1_developer_app_key_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Adds an API product to a developer app key, enabling the app that holds + # the key to access the API resources bundled in the API product. + # In addition, you can add + # attributes to a developer app key. This API replaces the + # existing attributes with those specified in the request. + # Include or exclude any existing attributes that you want to retain or + # delete, respectively. + # You can use the same key to access all API products + # associated with the app. + # @param [String] name + # Name of the developer app key. Use the following structure in your request: + # `organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key`` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] google_cloud_apigee_v1_developer_app_key_object + # @param [String] action + # Approve or revoke the consumer key by setting this value to + # `approve` or `revoke`, respectively. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_organization_developer_app_key_developer_app_key(name, google_cloud_apigee_v1_developer_app_key_object = nil, action: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation + command.request_object = google_cloud_apigee_v1_developer_app_key_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey + command.params['name'] = name unless name.nil? + command.query['action'] = action unless action.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Removes an API product from an app's consumer key. After the API product is + # removed, the app cannot access the API resources defined in + # that API product. + # **Note**: The consumer key is not removed, only its association with the + # API product. + # @param [String] name + # Name of the API product in the developer app key in the following + # format: + # `organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key`/ + # apiproducts/`apiproduct`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_developer_app_key_apiproduct(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Approve or revoke an app's consumer key. After a consumer key is approved, + # the app can use it to access APIs. + # A consumer key that is revoked or pending cannot be used to access an API. + # Any access tokens associated with a revoked consumer key will remain + # active. However, Apigee hybrid checks the status of the consumer key and + # if set to `revoked` will not allow access to the API. + # @param [String] name + # Name of the API product in the developer app key in the following + # format: + # `organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key`/ + # apiproducts/`apiproduct`` + # @param [String] action + # Approve or revoke the consumer key by setting this value to + # `approve` or `revoke`, respectively. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleProtobufEmpty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleProtobufEmpty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_organization_developer_app_key_apiproduct_developer_app_key_api_product(name, action: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty + command.params['name'] = name unless name.nil? + command.query['action'] = action unless action.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a custom consumer key and secret for a developer app. This is + # particularly useful if you want to migrate existing consumer keys and + # secrets to Apigee hybrid from another system. + # Consumer keys and secrets can contain letters, numbers, underscores, and + # hyphens. No other special characters are allowed. + # **Note**: To avoid service disruptions, a consumer key and secret + # should not exceed 2 KBs each. + # After creating the consumer key and secret, associate the key with + # an API product using the + # UpdateDeveloperAppKey API. + # If a consumer key and secret already exist, you can keep them or + # delete them using the + # DeleteDeveloperAppKey API. + # @param [String] parent + # Parent of the developer app key. Use the following structure in your + # request: + # `organizations/`org`/developers/`developer_email`/apps` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] google_cloud_apigee_v1_developer_app_key_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_organization_developer_app_key_create(parent, google_cloud_apigee_v1_developer_app_key_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/keys/create', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation + command.request_object = google_cloud_apigee_v1_developer_app_key_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a developer attribute. + # @param [String] name + # Required. Name of the developer attribute. Use the following structure in your + # request: + # `organizations/`org`/developers/`developer_email`/attributes/`attribute`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_developer_attribute(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns the value of the specified developer attribute. + # @param [String] name + # Required. Name of the developer attribute. Use the following structure in your + # request: + # `organizations/`org`/developers/`developer_email`/attributes/`attribute`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_developer_attribute(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns a list of all developer attributes. + # @param [String] parent + # Required. Email address of the developer for which attributes are being listed + # in the + # following format: + # `organizations/`org`/developers/`developer_email`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_developer_attributes(parent, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/attributes', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates a developer attribute. + # **Note**: OAuth access tokens and Key Management Service (KMS) entities + # (apps, developers, and API products) are cached for 180 seconds + # (default). Any custom attributes associated with these entities + # are cached for at least 180 seconds after the entity is accessed at + # runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy + # won't be able to expire an access token in less than 180 seconds. + # @param [String] name + # Required. Name of the developer attribute. Use the following structure in your + # request: + # `organizations/`org`/developers/`developer_email`/attributes/`attribute`` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] google_cloud_apigee_v1_attribute_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_organization_developer_attribute_developer_attribute(name, google_cloud_apigee_v1_attribute_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation + command.request_object = google_cloud_apigee_v1_attribute_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates an environment in an organization. + # @param [String] parent + # Required. Name of the organization in which the environment will + # be created. Use the following structure in your request: + # `organizations/`org`` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment] google_cloud_apigee_v1_environment_object + # @param [String] name + # Optional. Name of the environment. Alternatively, the name may + # be specified in the request body in the + # environment_id field. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_organization_environment(parent, google_cloud_apigee_v1_environment_object = nil, name: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/environments', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment::Representation + command.request_object = google_cloud_apigee_v1_environment_object + command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation + command.params['parent'] = parent unless parent.nil? + command.query['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an environment from an organization. + # @param [String] name + # Required. Name of the environment. Use the following structure in your + # request: + # `organizations/`org`/environments/`env`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_environment(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets environment details. + # @param [String] name + # Required. Name of the environment. Use the following structure in your request: + # `organizations/`org`/environments/`env`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_environment(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Get Google Cloud Storage (GCS) signed url for specific organization and + # environment. Collection agent uses this signed url to upload data + # to GCS bucket. + # @param [String] name + # Required. The parent organization and environment names. Must be of the + # form `organizations/`org`/environments/`env`/datalocation`. + # @param [String] content_type + # Content-Type for uploaded file. + # @param [String] dataset + # Required. Dataset could be one of `api`, `mint`, `trace` and `event` + # @param [String] relative_file_path + # Required. Relative path to the GCS bucket + # @param [String] repo + # Required. Repository name + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataLocation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataLocation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_environment_datalocation(name, content_type: nil, dataset: nil, relative_file_path: nil, repo: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataLocation::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataLocation + command.params['name'] = name unless name.nil? + command.query['contentType'] = content_type unless content_type.nil? + command.query['dataset'] = dataset unless dataset.nil? + command.query['relativeFilePath'] = relative_file_path unless relative_file_path.nil? + command.query['repo'] = repo unless repo.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the debug mask singleton resource for an environment. + # @param [String] name + # Required. Name of the debug mask. Use the following structure in your request: + # `organizations/`org`/environments/`env`/debugmask`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_environment_debugmask(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the deployed configuration for an environment. + # @param [String] name + # Required. Name of the environment deployed configuration resource. Use the + # following + # structure in your request: + # `organizations/`org`/environments/`env`/deployedConfig` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentConfig] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentConfig] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_environment_deployed_config(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentConfig::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentConfig + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the IAM policy on an environment. For more information, see + # [Manage users, roles, and permissions + # using the API](https://docs.apigee.com/hybrid/latest/manage-users-roles). + # You must have the `apigee.environments.getIamPolicy` permission to call + # this API. + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Fixnum] options_requested_policy_version + # Optional. The policy format version to be returned. + # Valid values are 0, 1, and 3. Requests specifying an invalid value will be + # rejected. + # Requests for policies with any conditional bindings must specify version 3. + # Policies without any conditional bindings may specify any valid value or + # leave the field unset. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleIamV1Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleIamV1Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_environment_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleIamV1Policy::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleIamV1Policy + command.params['resource'] = resource unless resource.nil? + command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the IAM policy on an environment, if the policy already + # exists it will be replaced. For more information, see + # [Manage users, roles, and permissions + # using the API](https://docs.apigee.com/hybrid/latest/manage-users-roles). + # You must have the `apigee.environments.setIamPolicy` permission to + # call this API. + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::ApigeeV1::GoogleIamV1SetIamPolicyRequest] google_iam_v1_set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleIamV1Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleIamV1Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_organization_environment_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleIamV1SetIamPolicyRequest::Representation + command.request_object = google_iam_v1_set_iam_policy_request_object + command.response_representation = Google::Apis::ApigeeV1::GoogleIamV1Policy::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleIamV1Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a subscription for the environment's Pub/Sub topic. + # The server will assign a random name for this subscription. + # The "name" and "push_config" must *not* be specified. + # @param [String] parent + # Required. Name of the environment. Use the following structure in your request: + # `organizations/`org`/environments/`env`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Subscription] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Subscription] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def subscribe_organization_environment(parent, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}:subscribe', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Subscription::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Subscription + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Tests the permissions of a user on an environment, + # and returns a subset of permissions that the user has on the environment. + # If the environment does not exist, an empty permission set is returned + # (a NOT_FOUND error is not returned). + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::ApigeeV1::GoogleIamV1TestIamPermissionsRequest] google_iam_v1_test_iam_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleIamV1TestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleIamV1TestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_organization_environment_iam_permissions(resource, google_iam_v1_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleIamV1TestIamPermissionsRequest::Representation + command.request_object = google_iam_v1_test_iam_permissions_request_object + command.response_representation = Google::Apis::ApigeeV1::GoogleIamV1TestIamPermissionsResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleIamV1TestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a subscription for the environment's Pub/Sub topic. + # @param [String] parent + # Required. Name of the environment. Use the following structure in your request: + # `organizations/`org`/environments/`env`` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Subscription] google_cloud_apigee_v1_subscription_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleProtobufEmpty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleProtobufEmpty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def unsubscribe_organization_environment(parent, google_cloud_apigee_v1_subscription_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}:unsubscribe', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Subscription::Representation + command.request_object = google_cloud_apigee_v1_subscription_object + command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing environment. + # When updating properties, you must pass all existing properties to the API, + # even if they are not being changed. If you omit properties from the + # payload, the properties are removed. To get the current list of + # properties for the environment, use the [Get Environment API](get). + # @param [String] name + # Required. Name of the environment. Use the following structure in your request: + # `organizations/`org`/environments/`env`` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment] google_cloud_apigee_v1_environment_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_organization_environment(name, google_cloud_apigee_v1_environment_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v1/{+name}', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment::Representation + command.request_object = google_cloud_apigee_v1_environment_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the debug mask singleton resource for an environment. + # @param [String] name + # Name of the debug mask. + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask] google_cloud_apigee_v1_debug_mask_object + # @param [Boolean] replace_repeated_fields + # Boolean flag that specifies whether to replace existing values in the debug + # mask when doing an update. Set to true to replace existing values. + # The default behavior is to append the values (false). + # @param [String] update_mask + # Field debug mask to support partial updates. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_organization_environment_debugmask(name, google_cloud_apigee_v1_debug_mask_object = nil, replace_repeated_fields: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/{+name}', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask::Representation + command.request_object = google_cloud_apigee_v1_debug_mask_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask + command.params['name'] = name unless name.nil? + command.query['replaceRepeatedFields'] = replace_repeated_fields unless replace_repeated_fields.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing environment. + # When updating properties, you must pass all existing properties to the API, + # even if they are not being changed. If you omit properties from the + # payload, the properties are removed. To get the current list of + # properties for the environment, use the [Get Environment API](get). + # @param [String] name + # Required. Name of the environment. Use the following structure in your request: + # `organizations/`org`/environments/`env`` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment] google_cloud_apigee_v1_environment_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_organization_environment_environment(name, google_cloud_apigee_v1_environment_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment::Representation + command.request_object = google_cloud_apigee_v1_environment_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Get a list of metrics and dimensions which can be used for creating + # analytics queries and reports. + # Each schema element contains the name of the field with its associated type + # and if it is either custom field or standard field. + # @param [String] name + # Required. The parent organization and environment names. Must be of the + # form `organizations/`org`/environments/`env`/analytics/admin/schemav2`. + # @param [String] type + # Required. Type refers to the dataset name whose schema needs to be + # retrieved E.g. type=fact or type=agg_cus1 + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Schema] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Schema] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_environment_analytic_admin_schemav2(name, type: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Schema::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Schema + command.params['name'] = name unless name.nil? + command.query['type'] = type unless type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all deployments of an API proxy in an environment. + # @param [String] parent + # Required. Name representing an API proxy in an environment in the following + # format: + # `organizations/`org`/environments/`env`/apis/`api`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_environment_api_deployments(parent, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/deployments', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Undeploys an API proxy revision from an environment. + # Because multiple revisions of the same API proxy can be deployed in + # the same environment if the base paths are different, you must specify the + # revision number of the API proxy. + # @param [String] name + # Required. Name of the API proxy revision deployment in the following format: + # `organizations/`org`/environments/`env`/apis/`api`/revisions/`rev`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleProtobufEmpty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleProtobufEmpty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def deployments_organization_environment_api_revision(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}/deployments', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the deployment of an API proxy revision and actual state reported by + # runtime pods. + # @param [String] name + # Required. Name representing an API proxy revision in an + # environment in the following format: + # `organizations/`org`/environments/`env`/apis/`api`/revisions/`rev`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_environment_api_revision_deployments(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}/deployments', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a debug session for a deployed API Proxy revision. + # @param [String] parent + # Required. The resource name of the API Proxy revision deployment for which + # to create the DebugSession. Must be of the form + # `organizations/`organization`/environments/`environment`/apis/`api`/revisions/ + # `revision``. + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession] google_cloud_apigee_v1_debug_session_object + # @param [Fixnum] timeout + # Optional. The time in seconds after which this DebugSession should end. + # A timeout specified in DebugSession will overwrite this value. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_organization_environment_api_revision_debugsession(parent, google_cloud_apigee_v1_debug_session_object = nil, timeout: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/debugsessions', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession::Representation + command.request_object = google_cloud_apigee_v1_debug_session_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession + command.params['parent'] = parent unless parent.nil? + command.query['timeout'] = timeout unless timeout.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the data from a debug session. This does not cancel the debug + # session or prevent further data from being collected if the session is + # still active in runtime pods. + # @param [String] name + # Required. The name of the debug session to delete. + # Must be of the form: + # `organizations/`organization`/environments/`environment`/apis/`api`/revisions/ + # `revision`/debugsessions/`debugsession``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleProtobufEmpty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleProtobufEmpty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_environment_api_revision_debugsession_data(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}/data', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists debug sessions that are currently active in the given API Proxy + # revision. + # @param [String] parent + # Required. The name of the API Proxy revision deployment for which + # to list debug sessions. Must be of the form: + # `organizations/`organization`/environments/`environment`/apis/`api`/revisions/ + # `revision``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDebugSessionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDebugSessionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_environment_api_revision_debugsessions(parent, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/debugsessions', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDebugSessionsResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDebugSessionsResponse + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the debug data from a transaction. + # @param [String] name + # Required. The name of the debug session transaction. Must be of the form: + # `organizations/`organization`/environments/`environment`/apis/`api`/revisions/ + # `revision`/debugsessions/`session`/data/`transaction``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSessionTransaction] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSessionTransaction] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_environment_api_revision_debugsession_datum(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSessionTransaction::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSessionTransaction + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a cache. + # @param [String] name + # Required. Cache resource name of the form: + # `organizations/`organization_id`/environments/`environment_id`/caches/` + # cache_id`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleProtobufEmpty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleProtobufEmpty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_environment_cach(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all deployments of API proxies or shared flows in an environment. + # @param [String] parent + # Required. Name of the environment for which to return deployment information + # in the + # following format: + # `organizations/`org`/environments/`env`` + # @param [Boolean] shared_flows + # Optional. Flag that specifies whether to return shared flow or API proxy + # deployments. + # Set to `true` to return shared flow deployments; set to `false` + # to return API proxy deployments. Defaults to `false`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_environment_deployments(parent, shared_flows: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/deployments', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse + command.params['parent'] = parent unless parent.nil? + command.query['sharedFlows'] = shared_flows unless shared_flows.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Attaches a shared flow to a flow hook. + # @param [String] name + # Required. Name of the flow hook to which the shared flow should be + # attached in the following format: + # `organizations/`org`/environments/`env`/flowhooks/`flowhook`` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook] google_cloud_apigee_v1_flow_hook_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def attach_organization_environment_flowhook_shared_flow_to_flow_hook(name, google_cloud_apigee_v1_flow_hook_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v1/{+name}', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook::Representation + command.request_object = google_cloud_apigee_v1_flow_hook_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Detaches a shared flow from a flow hook. + # @param [String] name + # Required. Name of the flow hook to detach in the following format: + # `organizations/`org`/environments/`env`/flowhooks/`flowhook`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def detach_organization_environment_flowhook_shared_flow_from_flow_hook(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns the name of the shared flow attached to the specified flow hook. If + # there's no shared flow attached to the flow hook, the API does not return + # an error; it simply does not return a name in the response. + # @param [String] name + # Required. Name of the flow hook in the following format: + # `organizations/`org`/environments/`env`/flowhooks/`flowhook`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_environment_flowhook(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a keystore or truststore: + # * Keystore: Contains certificates and their associated keys. + # * Truststore: Contains trusted certificates used to validate a + # server's certificate. These certificates are typically self-signed + # certificates or certificates that are not signed by a trusted CA. + # @param [String] parent + # Required. The name of the environment in which to create the keystore. + # Must be of the form + # `organizations/`organization`/environments/`environment``. + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore] google_cloud_apigee_v1_keystore_object + # @param [String] name + # Optional. Overrides the value in Keystore. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_organization_environment_keystore(parent, google_cloud_apigee_v1_keystore_object = nil, name: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/keystores', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore::Representation + command.request_object = google_cloud_apigee_v1_keystore_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore + command.params['parent'] = parent unless parent.nil? + command.query['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a keystore or truststore. + # @param [String] name + # Required. The name of keystore to delete. Must be of the form + # `organizations/`organization`/environments/`environment`/keystores/`keystore``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_environment_keystore(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a keystore or truststore. + # @param [String] name + # Required. The name of keystore. Must be of the form + # `organizations/`organization`/environments/`environment`/keystores/`keystore``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_environment_keystore(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates an alias from a key, certificate pair. + # The structure of the request is controlled by the `format` query parameter: + # * `keycertfile` - Separate PEM-encoded key and certificate files are + # uploaded. The request must have `Content-Type: multipart/form-data` and + # include fields `keyFile` and `certFile`. If uploading to a truststore, + # omit `keyFile`. + # * `pkcs12` - A PKCS12 file is uploaded. The request must have + # `Content-Type: multipart/form-data` with the file provided in the only + # field. + # * `selfsignedcert` - A new private key and certificate are generated. The + # request must have `Content-Type: application/json` and a body of + # CertificateGenerationSpec. + # @param [String] parent + # Required. The name of the keystore. Must be of the form + # `organizations/`organization`/environments/`environment`/keystores/`keystore``. + # @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object + # @param [String] _password + # The password for the private key file, if it exists. + # @param [String] alias_ + # The alias for the key, certificate pair. Values must match + # regular expression `[\w\s-.]`1,255``. This must be provided for all formats + # except 'selfsignedcert'; self-signed certs may specify the alias in either + # this parameter or the JSON body. + # @param [String] format + # Required. The format of the data. Must be either `selfsignedcert`, + # `keycertfile`, or `pkcs12`. + # @param [Boolean] ignore_expiry_validation + # If `true`, no expiry validation will be performed. + # @param [Boolean] ignore_newline_validation + # If `true`, do not throw an error when the file contains a chain with no + # newline between each certificate. By default, a newline is needed between + # each certificate in a chain. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_organization_environment_keystore_alias(parent, google_api_http_body_object = nil, _password: nil, alias_: nil, format: nil, ignore_expiry_validation: nil, ignore_newline_validation: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/aliases', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation + command.request_object = google_api_http_body_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias + command.params['parent'] = parent unless parent.nil? + command.query['_password'] = _password unless _password.nil? + command.query['alias'] = alias_ unless alias_.nil? + command.query['format'] = format unless format.nil? + command.query['ignoreExpiryValidation'] = ignore_expiry_validation unless ignore_expiry_validation.nil? + command.query['ignoreNewlineValidation'] = ignore_newline_validation unless ignore_newline_validation.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Generates a PKCS #10 Certificate Signing Request for the private key in + # an alias. + # @param [String] name + # Required. The name of the alias. Must be of the form + # `organizations/`organization`/environments/`environment`/keystores/`keystore`/ + # aliases/`alias``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleApiHttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleApiHttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def csr_organization_environment_keystore_alias(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}/csr', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleApiHttpBody + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an alias. + # @param [String] name + # Required. The name of the alias. Must be of the form + # `organizations/`organization`/environments/`environment`/keystores/`keystore`/ + # aliases/`alias``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_environment_keystore_alias(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets an alias. + # @param [String] name + # Required. The name of the alias. Must be of the form + # `organizations/`organization`/environments/`environment`/keystores/`keystore`/ + # aliases/`alias``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_environment_keystore_alias(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the certificate from an alias in PEM-encoded form. + # @param [String] name + # Required. The name of the alias. Must be of the form + # `organizations/`organization`/environments/`environment`/keystores/`keystore`/ + # aliases/`alias``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleApiHttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleApiHttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_environment_keystore_alias_certificate(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}/certificate', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleApiHttpBody + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the certificate in an alias. + # @param [String] name + # Required. The name of the alias. Must be of the form + # `organizations/`organization`/environments/`environment`/keystores/`keystore`/ + # aliases/`alias``. + # @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object + # @param [Boolean] ignore_expiry_validation + # Required. If `true`, no expiry validation will be performed. + # @param [Boolean] ignore_newline_validation + # If `true`, do not throw an error when the file contains a chain with no + # newline between each certificate. By default, a newline is needed between + # each certificate in a chain. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_organization_environment_keystore_alias(name, google_api_http_body_object = nil, ignore_expiry_validation: nil, ignore_newline_validation: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v1/{+name}', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation + command.request_object = google_api_http_body_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias + command.params['name'] = name unless name.nil? + command.query['ignoreExpiryValidation'] = ignore_expiry_validation unless ignore_expiry_validation.nil? + command.query['ignoreNewlineValidation'] = ignore_newline_validation unless ignore_newline_validation.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a key value map in an environment. + # @param [String] parent + # Required. The name of the environment in which to create the key value map. + # Must be of the form + # `organizations/`organization`/environments/`environment``. + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] google_cloud_apigee_v1_key_value_map_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_organization_environment_keyvaluemap(parent, google_cloud_apigee_v1_key_value_map_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/keyvaluemaps', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation + command.request_object = google_cloud_apigee_v1_key_value_map_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Delete a key value map in an environment. + # @param [String] name + # Required. The name of the key value map. + # Must be of the form + # `organizations/`organization`/environments/`environment`/keyvaluemaps/` + # keyvaluemap``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_environment_keyvaluemap(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # This api is similar to GetStats + # except that the response is less verbose. + # In the current scheme, a query parameter _optimized instructs + # Edge Analytics to change the response but since this behavior + # is not possible with protocol buffer and since this parameter is + # predominantly used by Edge UI, we are introducing a separate api. + # @param [String] name + # Required. The organization and environment name for which the interactive + # query will be executed. Must be of the form + # `organizations/`organization_id`/environments/`environment_id/stats/` + # dimensions`` + # Dimensions let you view metrics in meaningful groupings. E.g. apiproxy, + # target_host. The value of dimensions should be comma separated list as + # shown below + # `organizations/`org`/environments/`env`/stats/apiproxy,request_verb` + # @param [String] accuracy + # Legacy field. not used anymore + # @param [String] agg_table + # If customers want to query custom aggregate tables, then this parameter + # can be used to specify the table name. If this parameter is skipped, then + # Edge Query will try to retrieve the data from fact tables which will be + # expensive. + # @param [String] filter + # Enables drill-down on specific dimension values + # @param [String] limit + # This parameter is used to limit the number of result items. + # Default and the max value is 14400 + # @param [String] offset + # Use offset with limit to enable pagination of results. For example, + # to display results 11-20, set limit to '10' and offset to '10'. + # @param [Boolean] realtime + # Legacy field: not used anymore + # @param [String] select + # Required. The select parameter contains a comma separated list of metrics + # E.g. sum(message_count),sum(error_count) + # @param [Boolean] sonar + # This parameter routes the query to api monitoring service for last hour + # @param [String] sort + # This parameter specifies if the sort order should be ascending or + # descending Supported values are DESC and ASC. + # @param [String] sortby + # Comma separated list of columns to sort the final result. + # @param [String] time_range + # Required. Time interval for the interactive query. + # Time range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59 + # @param [String] time_unit + # A value of second, minute, hour, day, week, month. + # Time Unit specifies the granularity of metrics returned. + # @param [String] topk + # Take 'top k' results from results, for example, to return the top 5 + # results 'topk=5'. + # @param [Boolean] ts_ascending + # Lists timestamps in ascending order if set to true. Recommend setting + # this value to true if you are using sortby with sort=DESC. + # @param [String] tzo + # This parameters contains the timezone offset value + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStats] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStats] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_environment_optimized_stat(name, accuracy: nil, agg_table: nil, filter: nil, limit: nil, offset: nil, realtime: nil, select: nil, sonar: nil, sort: nil, sortby: nil, time_range: nil, time_unit: nil, topk: nil, ts_ascending: nil, tzo: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStats::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStats + command.params['name'] = name unless name.nil? + command.query['accuracy'] = accuracy unless accuracy.nil? + command.query['aggTable'] = agg_table unless agg_table.nil? + command.query['filter'] = filter unless filter.nil? + command.query['limit'] = limit unless limit.nil? + command.query['offset'] = offset unless offset.nil? + command.query['realtime'] = realtime unless realtime.nil? + command.query['select'] = select unless select.nil? + command.query['sonar'] = sonar unless sonar.nil? + command.query['sort'] = sort unless sort.nil? + command.query['sortby'] = sortby unless sortby.nil? + command.query['timeRange'] = time_range unless time_range.nil? + command.query['timeUnit'] = time_unit unless time_unit.nil? + command.query['topk'] = topk unless topk.nil? + command.query['tsAscending'] = ts_ascending unless ts_ascending.nil? + command.query['tzo'] = tzo unless tzo.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Submit a query to be processed in the background. + # If the submission of the query succeeds, the API returns a 201 status and + # an ID that refer to the query. In addition to the HTTP status 201, the + # `state` of "enqueued" means that the request succeeded. + # @param [String] parent + # Required. The parent organization and environment names. + # Must be of the form `organizations/`org`/environments/`env``. + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Query] google_cloud_apigee_v1_query_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_organization_environment_query(parent, google_cloud_apigee_v1_query_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/queries', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Query::Representation + command.request_object = google_cloud_apigee_v1_query_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Get query status + # If the query is still in progress, the `state` is set to "running" + # After the query has completed successfully, `state` is set to "completed" + # @param [String] name + # Required. Name of the asynchronous query to get. Must be of the form + # `organizations/`org`/environments/`env`/queries/`queryId``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_environment_query(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # After the query is completed, use this API to retrieve the results. + # If the request succeeds, and there is a non-zero result set, the result is + # downloaded to the client as a zipped JSON file. + # The name of the downloaded file will be: + # OfflineQueryResult-.zip + # Example: `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` + # @param [String] name + # Required. Name of the asynchronous query result to get. Must be of the + # form `organizations/`org`/environments/`env`/queries/`queryId`/result`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleApiHttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleApiHttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_environment_query_result(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleApiHttpBody + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # + # @param [String] name + # Required. Name of the asynchronous query result view to get. Must be of the + # form `organizations/`org`/environments/`env`/queries/`queryId`/resultView`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQueryResultView] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQueryResultView] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_environment_query_result_view(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQueryResultView::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQueryResultView + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Return a list of Asynchronous Queries + # @param [String] parent + # Required. The parent organization and environment names. + # Must be of the form `organizations/`org`/environments/`env``. + # @param [String] dataset + # Filter response list by dataset. + # Example: `api`, `mint` + # @param [String] from + # Filter response list by returning asynchronous queries that + # created after this date time. + # Time must be in ISO date-time format like '2011-12-03T10:15:30Z'. + # @param [String] incl_queries_without_report + # Flag to include asynchronous queries that don't have a report + # denifition. + # @param [String] status + # Filter response list by asynchronous query status + # @param [String] submitted_by + # Filter response list by user who submitted queries + # @param [String] to + # Filter response list by returning asynchronous queries that + # created before this date time. + # Time must be in ISO date-time format like '2011-12-03T10:16:30Z'. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAsyncQueriesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAsyncQueriesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_environment_queries(parent, dataset: nil, from: nil, incl_queries_without_report: nil, status: nil, submitted_by: nil, to: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/queries', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAsyncQueriesResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAsyncQueriesResponse + command.params['parent'] = parent unless parent.nil? + command.query['dataset'] = dataset unless dataset.nil? + command.query['from'] = from unless from.nil? + command.query['inclQueriesWithoutReport'] = incl_queries_without_report unless incl_queries_without_report.nil? + command.query['status'] = status unless status.nil? + command.query['submittedBy'] = submitted_by unless submitted_by.nil? + command.query['to'] = to unless to.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a Reference in the specified environment. + # @param [String] parent + # Required. The parent environment name under which the Reference will + # be created. Must be of the form `organizations/`org`/environments/`env``. + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference] google_cloud_apigee_v1_reference_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_organization_environment_reference(parent, google_cloud_apigee_v1_reference_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/references', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference::Representation + command.request_object = google_cloud_apigee_v1_reference_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a Reference from an environment. Returns the deleted + # Reference resource. + # @param [String] name + # Required. The name of the Reference to delete. Must be + # of the form `organizations/`org`/environments/`env`/references/`ref``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_environment_reference(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a Reference resource. + # @param [String] name + # Required. The name of the Reference to get. Must be of the form + # `organizations/`org`/environments/`env`/references/`ref``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_environment_reference(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing Reference. Note that this operation has PUT + # semantics; it will replace the entirety of the existing Reference with + # the resource in the request body. + # @param [String] name + # Required. The name of the Reference to update. Must be of the form + # `organizations/`org`/environments/`env`/references/`ref``. + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference] google_cloud_apigee_v1_reference_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_organization_environment_reference(name, google_cloud_apigee_v1_reference_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v1/{+name}', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference::Representation + command.request_object = google_cloud_apigee_v1_reference_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a resource file. + # Specify the `Content-Type` as `application/octet-stream` or + # `multipart/form-data`. + # For more information about resource files, see + # [Resource files](/api-platform/develop/resource-files). + # @param [String] parent + # Required. Name of the environment in which to create the resource file in the + # following format: + # `organizations/`org`/environments/`env``. + # @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object + # @param [String] name + # Required. Name of the resource file. Must match the regular expression: + # [a-zA-Z0-9:/\\!@#$%^&``\[\]()+\-=,.~'` ]`1,255` + # @param [String] type + # Required. Resource file type. `` resource_file_type `` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_organization_environment_resourcefile(parent, google_api_http_body_object = nil, name: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/resourcefiles', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation + command.request_object = google_api_http_body_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile + command.params['parent'] = parent unless parent.nil? + command.query['name'] = name unless name.nil? + command.query['type'] = type unless type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a resource file. + # For more information about resource files, see + # [Resource files](/api-platform/develop/resource-files). + # @param [String] parent + # Required. Name of the environment in the following format: + # `organizations/`org`/environments/`env``. + # @param [String] type + # Required. Resource file type. `` resource_file_type `` + # @param [String] name + # Required. ID of the resource file to delete. Must match the regular + # expression: [a-zA-Z0-9:/\\!@#$%^&``\[\]()+\-=,.~'` ]`1,255` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_environment_resourcefile(parent, type, name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+parent}/resourcefiles/{type}/{name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile + command.params['parent'] = parent unless parent.nil? + command.params['type'] = type unless type.nil? + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the contents of a resource file. + # For more information about resource files, see + # [Resource files](/api-platform/develop/resource-files). + # @param [String] parent + # Required. Name of the environment in the following format: + # `organizations/`org`/environments/`env``. + # @param [String] type + # Required. Resource file type. `` resource_file_type `` + # @param [String] name + # Required. ID of the resource file. Must match the regular + # expression: [a-zA-Z0-9:/\\!@#$%^&``\[\]()+\-=,.~'` ]`1,255` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleApiHttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleApiHttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_environment_resourcefile(parent, type, name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/resourcefiles/{type}/{name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleApiHttpBody + command.params['parent'] = parent unless parent.nil? + command.params['type'] = type unless type.nil? + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all resource files. + # For more information about resource files, see + # [Resource files](/api-platform/develop/resource-files). + # @param [String] parent + # Required. Name of the environment in which to list resource files in the + # following + # format: + # `organizations/`org`/environments/`env``. + # @param [String] type + # Optional. Type of resource files to list. + # `` resource_file_type `` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentResourcesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentResourcesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_environment_resourcefiles(parent, type: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/resourcefiles', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentResourcesResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentResourcesResponse + command.params['parent'] = parent unless parent.nil? + command.query['type'] = type unless type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all resource files. + # For more information about resource files, see + # [Resource files](/api-platform/develop/resource-files). + # @param [String] parent + # Required. Name of the environment in which to list resource files in the + # following + # format: + # `organizations/`org`/environments/`env``. + # @param [String] type + # Optional. Type of resource files to list. + # `` resource_file_type `` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentResourcesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentResourcesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_environment_resourcefile_environment_resources(parent, type, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/resourcefiles/{type}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentResourcesResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentResourcesResponse + command.params['parent'] = parent unless parent.nil? + command.params['type'] = type unless type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates a resource file. + # Specify the `Content-Type` as `application/octet-stream` or + # `multipart/form-data`. + # For more information about resource files, see + # [Resource files](/api-platform/develop/resource-files). + # @param [String] parent + # Required. Name of the environment in the following format: + # `organizations/`org`/environments/`env``. + # @param [String] type + # Required. Resource file type. `` resource_file_type `` + # @param [String] name + # Required. ID of the resource file to update. Must match the regular + # expression: [a-zA-Z0-9:/\\!@#$%^&``\[\]()+\-=,.~'` ]`1,255` + # @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_organization_environment_resourcefile(parent, type, name, google_api_http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v1/{+parent}/resourcefiles/{type}/{name}', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation + command.request_object = google_api_http_body_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile + command.params['parent'] = parent unless parent.nil? + command.params['type'] = type unless type.nil? + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all deployments of a shared flow in an environment. + # @param [String] parent + # Required. Name representing a shared flow in an environment in the following + # format: + # `organizations/`org`/environments/`env`/sharedflows/`sharedflow`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_environment_sharedflow_deployments(parent, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/deployments', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Undeploys a shared flow revision from an environment. + # @param [String] name + # Required. Name of the shared flow revision to undeploy in the following format: + # `organizations/`org`/environments/`env`/sharedflows/`sharedflow`/revisions/` + # rev`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleProtobufEmpty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleProtobufEmpty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def deployments_organization_environment_sharedflow_revision(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}/deployments', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the deployment of a shared flow revision and actual state reported by + # runtime pods. + # @param [String] name + # Required. Name representing a shared flow in an environment in the following + # format: + # `organizations/`org`/environments/`env`/sharedflows/`sharedflow`/revisions/` + # rev`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_environment_sharedflow_revision_deployments(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}/deployments', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Retrieve metrics grouped by dimensions. + # The types of metrics you can retrieve include traffic, message counts, + # API call latency, response size, and cache hits and counts. + # Dimensions let you view metrics in meaningful groups. + # The stats api does accept dimensions as path params. The dimensions are + # optional in which case the metrics are computed on the entire data + # for the given timerange. + # @param [String] name + # Required. The organization and environment name for which the interactive + # query will be executed. Must be of the form + # `organizations/`organization_id`/environments/`environment_id/stats/` + # dimensions`` + # Dimensions let you view metrics in meaningful groupings. E.g. apiproxy, + # target_host. The value of dimensions should be comma separated list as + # shown below + # `organizations/`org`/environments/`env`/stats/apiproxy,request_verb` + # @param [String] accuracy + # Legacy field. not used anymore + # This field is present to support UI calls which still use this parameter + # @param [String] agg_table + # If customers want to query custom aggregate tables, then this parameter + # can be used to specify the table name. If this parameter is skipped, then + # Edge Query will try to retrieve the data from fact tables which will be + # expensive. + # @param [String] filter + # Enables drill-down on specific dimension values + # @param [String] limit + # This parameter is used to limit the number of result items. + # Default and the max value is 14400 + # @param [String] offset + # Use offset with limit to enable pagination of results. For example, + # to display results 11-20, set limit to '10' and offset to '10'. + # @param [Boolean] realtime + # Legacy field: not used anymore + # @param [String] select + # The select parameter contains a comma separated list of metrics + # E.g. sum(message_count),sum(error_count) + # @param [Boolean] sonar + # This parameter routes the query to api monitoring service for last hour + # @param [String] sort + # This parameter specifies if the sort order should be ascending or + # descending Supported values are DESC and ASC. + # @param [String] sortby + # Comma separated list of columns to sort the final result. + # @param [String] time_range + # Time interval for the interactive query. + # Time range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59 + # @param [String] time_unit + # A value of second, minute, hour, day, week, month. + # Time Unit specifies the granularity of metrics returned. + # @param [String] topk + # Take 'top k' results from results, for example, to return the top 5 + # results 'topk=5'. + # @param [Boolean] ts_ascending + # Lists timestamps in ascending order if set to true. Recommend setting + # this value to true if you are using sortby with sort=DESC. + # @param [String] tzo + # This parameters contains the timezone offset value + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Stats] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Stats] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_environment_stat(name, accuracy: nil, agg_table: nil, filter: nil, limit: nil, offset: nil, realtime: nil, select: nil, sonar: nil, sort: nil, sortby: nil, time_range: nil, time_unit: nil, topk: nil, ts_ascending: nil, tzo: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Stats::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Stats + command.params['name'] = name unless name.nil? + command.query['accuracy'] = accuracy unless accuracy.nil? + command.query['aggTable'] = agg_table unless agg_table.nil? + command.query['filter'] = filter unless filter.nil? + command.query['limit'] = limit unless limit.nil? + command.query['offset'] = offset unless offset.nil? + command.query['realtime'] = realtime unless realtime.nil? + command.query['select'] = select unless select.nil? + command.query['sonar'] = sonar unless sonar.nil? + command.query['sort'] = sort unless sort.nil? + command.query['sortby'] = sortby unless sortby.nil? + command.query['timeRange'] = time_range unless time_range.nil? + command.query['timeUnit'] = time_unit unless time_unit.nil? + command.query['topk'] = topk unless topk.nil? + command.query['tsAscending'] = ts_ascending unless ts_ascending.nil? + command.query['tzo'] = tzo unless tzo.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a TargetServer in the specified environment. + # @param [String] parent + # Required. The parent environment name under which the TargetServer will + # be created. Must be of the form `organizations/`org`/environments/`env``. + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer] google_cloud_apigee_v1_target_server_object + # @param [String] name + # Optional. The ID to give the TargetServer. This will overwrite the + # value in TargetServer. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_organization_environment_targetserver(parent, google_cloud_apigee_v1_target_server_object = nil, name: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/targetservers', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer::Representation + command.request_object = google_cloud_apigee_v1_target_server_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer + command.params['parent'] = parent unless parent.nil? + command.query['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a TargetServer from an environment. Returns the deleted + # TargetServer resource. + # @param [String] name + # Required. The name of the TargetServer to delete. Must be + # of the form + # `organizations/`org`/environments/`env`/targetservers/`target_server_id``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_environment_targetserver(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a TargetServer resource. + # @param [String] name + # Required. The name of the TargetServer to get. Must be of the form + # `organizations/`org`/environments/`env`/targetservers/`target_server_id``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_environment_targetserver(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing TargetServer. Note that this operation has PUT + # semantics; it will replace the entirety of the existing TargetServer with + # the resource in the request body. + # @param [String] name + # Required. The name of the TargetServer to replace. Must be of the form + # `organizations/`org`/environments/`env`/targetservers/`target_server_id``. + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer] google_cloud_apigee_v1_target_server_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_organization_environment_targetserver(name, google_cloud_apigee_v1_target_server_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v1/{+name}', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer::Representation + command.request_object = google_cloud_apigee_v1_target_server_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a key value map in an organization. + # @param [String] parent + # Required. The name of the organization in which to create the key value map + # file. Must be of the form `organizations/`organization``. + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] google_cloud_apigee_v1_key_value_map_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_organization_keyvaluemap(parent, google_cloud_apigee_v1_key_value_map_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/keyvaluemaps', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation + command.request_object = google_cloud_apigee_v1_key_value_map_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Delete a key value map in an organization. + # @param [String] name + # Required. The name of the key value map. + # Must be of the form + # `organizations/`organization`/keyvaluemaps/`keyvaluemap``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_keyvaluemap(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the latest state of a long-running operation. Clients can use this + # method to poll the operation result at intervals as recommended by the API + # service. + # @param [String] name + # The name of the operation resource. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists operations that match the specified filter in the request. If the + # server doesn't support this method, it returns `UNIMPLEMENTED`. + # NOTE: the `name` binding allows API services to override the binding + # to use different resource name schemes, such as `users/*/operations`. To + # override the binding, API services can add a binding such as + # `"/v1/`name=users/*`/operations"` to their service configuration. + # For backwards compatibility, the default name includes the operations + # collection id, however overriding users must ensure the name binding + # is the parent resource, without the operations collection id. + # @param [String] name + # The name of the operation's parent resource. + # @param [String] filter + # The standard list filter. + # @param [Fixnum] page_size + # The standard list page size. + # @param [String] page_token + # The standard list page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningListOperationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleLongrunningListOperationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}/operations', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningListOperationsResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningListOperationsResponse + command.params['name'] = name unless name.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a Custom Report for an Organization. A Custom Report + # provides Apigee Customers to create custom dashboards in addition + # to the standard dashboards which are provided. The Custom Report in its + # simplest form contains specifications about metrics, dimensions and + # filters. It is important to note that the custom report by itself does not + # provide an executable entity. The Edge UI converts the custom report + # definition into an analytics query and displays the result in a chart. + # @param [String] parent + # Required. The parent organization name under which the Custom Report will + # be created. Must be of the form: + # `organizations/`organization_id`/reports` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport] google_cloud_apigee_v1_custom_report_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_organization_report(parent, google_cloud_apigee_v1_custom_report_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/reports', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport::Representation + command.request_object = google_cloud_apigee_v1_custom_report_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an existing custom report definition + # @param [String] name + # Required. Custom Report name of the form: + # `organizations/`organization_id`/reports/`report_name`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeleteCustomReportResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeleteCustomReportResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_report(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeleteCustomReportResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeleteCustomReportResponse + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Retrieve a custom report definition. + # @param [String] name + # Required. Custom Report name of the form: + # `organizations/`organization_id`/reports/`report_name`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_report(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Return a list of Custom Reports + # @param [String] parent + # Required. The parent organization name under which the API product will + # be listed + # `organizations/`organization_id`/reports` + # @param [Boolean] expand + # Set to 'true' to get expanded details about each custom report. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListCustomReportsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListCustomReportsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_reports(parent, expand: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/reports', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListCustomReportsResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListCustomReportsResponse + command.params['parent'] = parent unless parent.nil? + command.query['expand'] = expand unless expand.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Update an existing custom report definition + # @param [String] name + # Required. Custom Report name of the form: + # `organizations/`organization_id`/reports/`report_name`` + # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport] google_cloud_apigee_v1_custom_report_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_organization_report(name, google_cloud_apigee_v1_custom_report_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v1/{+name}', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport::Representation + command.request_object = google_cloud_apigee_v1_custom_report_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Uploads a ZIP-formatted shared flow configuration bundle to an + # organization. If the shared flow already exists, this creates a new + # revision of it. If the shared flow does not exist, this creates it. + # Once imported, the shared flow revision must be deployed before it can be + # accessed at runtime. + # The size limit of a shared flow bundle is 15 MB. + # @param [String] parent + # Required. The name of the parent organization under which to create the + # shared flow. Must be of the form: + # `organizations/`organization_id`` + # @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object + # @param [String] action + # Required. Must be set to either `import` or `validate`. + # @param [String] name + # Required. The name to give the shared flow + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_organization_sharedflow(parent, google_api_http_body_object = nil, action: nil, name: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/sharedflows', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation + command.request_object = google_api_http_body_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision + command.params['parent'] = parent unless parent.nil? + command.query['action'] = action unless action.nil? + command.query['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a shared flow and all it's revisions. The shared flow must be + # undeployed before you can delete it. + # @param [String] name + # Required. shared flow name of the form: + # `organizations/`organization_id`/sharedflows/`shared_flow_id`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlow] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlow] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_sharedflow(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlow::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlow + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a shared flow by name, including a list of its revisions. + # @param [String] name + # Required. The name of the shared flow to get. Must be of the + # form: + # `organizations/`organization_id`/sharedflows/`shared_flow_id`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlow] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlow] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_sharedflow(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlow::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlow + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all shared flows in the organization. + # @param [String] parent + # Required. The name of the parent organization under which to get shared + # flows. Must be of the form: + # `organizations/`organization_id`` + # @param [Boolean] include_meta_data + # Indicates whether to include shared flow metadata in the response. + # @param [Boolean] include_revisions + # Indicates whether to include a list of revisions in the response. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSharedFlowsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSharedFlowsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_sharedflows(parent, include_meta_data: nil, include_revisions: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/sharedflows', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSharedFlowsResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSharedFlowsResponse + command.params['parent'] = parent unless parent.nil? + command.query['includeMetaData'] = include_meta_data unless include_meta_data.nil? + command.query['includeRevisions'] = include_revisions unless include_revisions.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all deployments of a shared flow. + # @param [String] parent + # Required. Name of the shared flow for which to return deployment information + # in the + # following format: + # `organizations/`org`/sharedflows/`sharedflow`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_sharedflow_deployments(parent, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/deployments', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a shared flow and all associated policies, resources, and + # revisions. You must undeploy the shared flow before deleting it. + # @param [String] name + # Required. The name of the shared flow revision to delete. Must be of the + # form: + # `organizations/`organization_id`/sharedflows/`shared_flow_id`/revisions/` + # revision_id`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_sharedflow_revision(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a revision of a shared flow. + # If `format=bundle` is passed, it instead outputs a shared flow revision as + # a ZIP-formatted bundle of code and config files. + # @param [String] name + # Required. The name of the shared flow revision to get. Must be of the + # form: + # `organizations/`organization_id`/sharedflows/`shared_flow_id`/revisions/` + # revision_id`` + # @param [String] format + # Specify `bundle` to export the contents of the shared flow bundle. + # Otherwise, the bundle metadata is returned. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleApiHttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleApiHttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_sharedflow_revision(name, format: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleApiHttpBody + command.params['name'] = name unless name.nil? + command.query['format'] = format unless format.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates a shared flow revision. This operation is only allowed on revisions + # which have never been deployed. After deployment a revision becomes + # immutable, even if it becomes undeployed. + # The payload is a ZIP-formatted shared flow. Content type must be either + # multipart/form-data or application/octet-stream. + # @param [String] name + # Required. The name of the shared flow revision to update. + # Must be of the form: + # `organizations/`organization_id`/sharedflows/`shared_flow_id`/revisions/` + # revision_id`` + # @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object + # @param [Boolean] validate + # Ignored. All uploads are validated regardless of the value of this field. + # It is kept for compatibility with existing APIs. Must be `true` or `false` + # if provided. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_organization_sharedflow_revision_shared_flow_revision(name, google_api_http_body_object = nil, validate: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}', options) + command.request_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation + command.request_object = google_api_http_body_object + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision + command.params['name'] = name unless name.nil? + command.query['validate'] = validate unless validate.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all deployments of a shared flow revision. + # @param [String] parent + # Required. Name of the API proxy revision for which to return deployment + # information + # in the following format: + # `organizations/`org`/sharedflows/`sharedflow`/revisions/`rev``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_sharedflow_revision_deployments(parent, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/deployments', options) + command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse::Representation + command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/bigquery_v2.rb b/generated/google/apis/bigquery_v2.rb index a1d640425..eb5c57f4f 100644 --- a/generated/google/apis/bigquery_v2.rb +++ b/generated/google/apis/bigquery_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/bigquery/ module BigqueryV2 VERSION = 'V2' - REVISION = '20200324' + REVISION = '20200415' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' diff --git a/generated/google/apis/bigquery_v2/classes.rb b/generated/google/apis/bigquery_v2/classes.rb index d1d93a145..b0f8c2643 100644 --- a/generated/google/apis/bigquery_v2/classes.rb +++ b/generated/google/apis/bigquery_v2/classes.rb @@ -174,17 +174,17 @@ module Google class ArimaFittingMetrics include Google::Apis::Core::Hashable - # AIC + # AIC. # Corresponds to the JSON property `aic` # @return [Float] attr_accessor :aic - # log-likelihood + # Log-likelihood. # Corresponds to the JSON property `logLikelihood` # @return [Float] attr_accessor :log_likelihood - # variance. + # Variance. # Corresponds to the JSON property `variance` # @return [Float] attr_accessor :variance @@ -215,11 +215,29 @@ module Google # @return [Google::Apis::BigqueryV2::ArimaFittingMetrics] attr_accessor :arima_fitting_metrics + # Whether Arima model fitted with drift or not. It is always false + # when d is not 1. + # Corresponds to the JSON property `hasDrift` + # @return [Boolean] + attr_accessor :has_drift + alias_method :has_drift?, :has_drift + # Arima order, can be used for both non-seasonal and seasonal parts. # Corresponds to the JSON property `nonSeasonalOrder` # @return [Google::Apis::BigqueryV2::ArimaOrder] attr_accessor :non_seasonal_order + # Seasonal periods. Repeated because multiple periods are supported + # for one time series. + # Corresponds to the JSON property `seasonalPeriods` + # @return [Array] + attr_accessor :seasonal_periods + + # The id to indicate different time series. + # Corresponds to the JSON property `timeSeriesId` + # @return [String] + attr_accessor :time_series_id + def initialize(**args) update!(**args) end @@ -228,7 +246,10 @@ module Google def update!(**args) @arima_coefficients = args[:arima_coefficients] if args.key?(:arima_coefficients) @arima_fitting_metrics = args[:arima_fitting_metrics] if args.key?(:arima_fitting_metrics) + @has_drift = args[:has_drift] if args.key?(:has_drift) @non_seasonal_order = args[:non_seasonal_order] if args.key?(:non_seasonal_order) + @seasonal_periods = args[:seasonal_periods] if args.key?(:seasonal_periods) + @time_series_id = args[:time_series_id] if args.key?(:time_series_id) end end @@ -959,6 +980,31 @@ module Google end end + # + class ConnectionProperty + include Google::Apis::Core::Hashable + + # [Required] Name of the connection property to set. + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + + # [Required] Value of the connection property. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @key = args[:key] if args.key?(:key) + @value = args[:value] if args.key?(:value) + end + end + # class CsvOptions include Google::Apis::Core::Hashable @@ -1819,12 +1865,6 @@ module Google # @return [Google::Apis::BigqueryV2::GoogleSheetsOptions] attr_accessor :google_sheets_options - # [Optional, Trusted Tester] Deprecated, do not use. Please set - # hivePartitioningOptions instead. - # Corresponds to the JSON property `hivePartitioningMode` - # @return [String] - attr_accessor :hive_partitioning_mode - # [Optional, Trusted Tester] Options to configure hive partitioning support. # Corresponds to the JSON property `hivePartitioningOptions` # @return [Google::Apis::BigqueryV2::HivePartitioningOptions] @@ -1892,7 +1932,6 @@ module Google @compression = args[:compression] if args.key?(:compression) @csv_options = args[:csv_options] if args.key?(:csv_options) @google_sheets_options = args[:google_sheets_options] if args.key?(:google_sheets_options) - @hive_partitioning_mode = args[:hive_partitioning_mode] if args.key?(:hive_partitioning_mode) @hive_partitioning_options = args[:hive_partitioning_options] if args.key?(:hive_partitioning_options) @ignore_unknown_values = args[:ignore_unknown_values] if args.key?(:ignore_unknown_values) @max_bad_records = args[:max_bad_records] if args.key?(:max_bad_records) @@ -2518,12 +2557,6 @@ module Google # @return [String] attr_accessor :field_delimiter - # [Optional, Trusted Tester] Deprecated, do not use. Please set - # hivePartitioningOptions instead. - # Corresponds to the JSON property `hivePartitioningMode` - # @return [String] - attr_accessor :hive_partitioning_mode - # [Optional, Trusted Tester] Options to configure hive partitioning support. # Corresponds to the JSON property `hivePartitioningOptions` # @return [Google::Apis::BigqueryV2::HivePartitioningOptions] @@ -2684,7 +2717,6 @@ module Google @destination_table_properties = args[:destination_table_properties] if args.key?(:destination_table_properties) @encoding = args[:encoding] if args.key?(:encoding) @field_delimiter = args[:field_delimiter] if args.key?(:field_delimiter) - @hive_partitioning_mode = args[:hive_partitioning_mode] if args.key?(:hive_partitioning_mode) @hive_partitioning_options = args[:hive_partitioning_options] if args.key?(:hive_partitioning_options) @ignore_unknown_values = args[:ignore_unknown_values] if args.key?(:ignore_unknown_values) @max_bad_records = args[:max_bad_records] if args.key?(:max_bad_records) @@ -2728,7 +2760,7 @@ module Google # Connection properties. # Corresponds to the JSON property `connectionProperties` - # @return [Array] + # @return [Array] attr_accessor :connection_properties # [Optional] Specifies whether the job is allowed to create new tables. The @@ -4186,7 +4218,7 @@ module Google # Connection properties. # Corresponds to the JSON property `connectionProperties` - # @return [Array] + # @return [Array] attr_accessor :connection_properties # [Optional] Specifies the default datasetId and projectId to assume for any diff --git a/generated/google/apis/bigquery_v2/representations.rb b/generated/google/apis/bigquery_v2/representations.rb index 92aa43df7..30effed06 100644 --- a/generated/google/apis/bigquery_v2/representations.rb +++ b/generated/google/apis/bigquery_v2/representations.rb @@ -160,6 +160,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ConnectionProperty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class CsvOptions class Representation < Google::Apis::Core::JsonRepresentation; end @@ -767,8 +773,11 @@ module Google property :arima_fitting_metrics, as: 'arimaFittingMetrics', class: Google::Apis::BigqueryV2::ArimaFittingMetrics, decorator: Google::Apis::BigqueryV2::ArimaFittingMetrics::Representation + property :has_drift, as: 'hasDrift' property :non_seasonal_order, as: 'nonSeasonalOrder', class: Google::Apis::BigqueryV2::ArimaOrder, decorator: Google::Apis::BigqueryV2::ArimaOrder::Representation + collection :seasonal_periods, as: 'seasonalPeriods' + property :time_series_id, as: 'timeSeriesId' end end @@ -959,6 +968,14 @@ module Google end end + class ConnectionProperty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :key, as: 'key' + property :value, as: 'value' + end + end + class CsvOptions # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1157,7 +1174,6 @@ module Google property :google_sheets_options, as: 'googleSheetsOptions', class: Google::Apis::BigqueryV2::GoogleSheetsOptions, decorator: Google::Apis::BigqueryV2::GoogleSheetsOptions::Representation - property :hive_partitioning_mode, as: 'hivePartitioningMode' property :hive_partitioning_options, as: 'hivePartitioningOptions', class: Google::Apis::BigqueryV2::HivePartitioningOptions, decorator: Google::Apis::BigqueryV2::HivePartitioningOptions::Representation property :ignore_unknown_values, as: 'ignoreUnknownValues' @@ -1320,7 +1336,6 @@ module Google property :encoding, as: 'encoding' property :field_delimiter, as: 'fieldDelimiter' - property :hive_partitioning_mode, as: 'hivePartitioningMode' property :hive_partitioning_options, as: 'hivePartitioningOptions', class: Google::Apis::BigqueryV2::HivePartitioningOptions, decorator: Google::Apis::BigqueryV2::HivePartitioningOptions::Representation property :ignore_unknown_values, as: 'ignoreUnknownValues' @@ -1351,7 +1366,8 @@ module Google property :allow_large_results, as: 'allowLargeResults' property :clustering, as: 'clustering', class: Google::Apis::BigqueryV2::Clustering, decorator: Google::Apis::BigqueryV2::Clustering::Representation - collection :connection_properties, as: 'connectionProperties' + collection :connection_properties, as: 'connectionProperties', class: Google::Apis::BigqueryV2::ConnectionProperty, decorator: Google::Apis::BigqueryV2::ConnectionProperty::Representation + property :create_disposition, as: 'createDisposition' property :default_dataset, as: 'defaultDataset', class: Google::Apis::BigqueryV2::DatasetReference, decorator: Google::Apis::BigqueryV2::DatasetReference::Representation @@ -1730,7 +1746,8 @@ module Google class QueryRequest # @private class Representation < Google::Apis::Core::JsonRepresentation - collection :connection_properties, as: 'connectionProperties' + collection :connection_properties, as: 'connectionProperties', class: Google::Apis::BigqueryV2::ConnectionProperty, decorator: Google::Apis::BigqueryV2::ConnectionProperty::Representation + property :default_dataset, as: 'defaultDataset', class: Google::Apis::BigqueryV2::DatasetReference, decorator: Google::Apis::BigqueryV2::DatasetReference::Representation property :dry_run, as: 'dryRun' diff --git a/generated/google/apis/bigqueryconnection_v1beta1.rb b/generated/google/apis/bigqueryconnection_v1beta1.rb index be05236af..f775ca688 100644 --- a/generated/google/apis/bigqueryconnection_v1beta1.rb +++ b/generated/google/apis/bigqueryconnection_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/bigquery/ module BigqueryconnectionV1beta1 VERSION = 'V1beta1' - REVISION = '20200303' + REVISION = '20200415' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' diff --git a/generated/google/apis/bigqueryconnection_v1beta1/classes.rb b/generated/google/apis/bigqueryconnection_v1beta1/classes.rb index 2de67a0fa..39e63a6da 100644 --- a/generated/google/apis/bigqueryconnection_v1beta1/classes.rb +++ b/generated/google/apis/bigqueryconnection_v1beta1/classes.rb @@ -697,8 +697,7 @@ module Google # 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" - # This field is only used by Cloud IAM. + # `paths: "bindings, etag"` # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask diff --git a/generated/google/apis/bigqueryconnection_v1beta1/service.rb b/generated/google/apis/bigqueryconnection_v1beta1/service.rb index b0288810e..694823618 100644 --- a/generated/google/apis/bigqueryconnection_v1beta1/service.rb +++ b/generated/google/apis/bigqueryconnection_v1beta1/service.rb @@ -259,7 +259,7 @@ module Google # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. @@ -295,7 +295,7 @@ module Google # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. diff --git a/generated/google/apis/bigqueryreservation_v1.rb b/generated/google/apis/bigqueryreservation_v1.rb index 207236cde..e3ed40843 100644 --- a/generated/google/apis/bigqueryreservation_v1.rb +++ b/generated/google/apis/bigqueryreservation_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/bigquery/ module BigqueryreservationV1 VERSION = 'V1' - REVISION = '20200403' + REVISION = '20200410' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' diff --git a/generated/google/apis/bigqueryreservation_v1/classes.rb b/generated/google/apis/bigqueryreservation_v1/classes.rb index 8619a2abd..dede78493 100644 --- a/generated/google/apis/bigqueryreservation_v1/classes.rb +++ b/generated/google/apis/bigqueryreservation_v1/classes.rb @@ -96,10 +96,10 @@ module Google end # Capacity commitment is a way to purchase compute capacity for BigQuery jobs - # (in the form of slots) with some committed period of usage. Monthly and - # annual commitments renew by default. Only flex commitments can be removed. In - # order to remove monthly or annual commitments, their plan needs to be changed - # to flex first. + # (in the form of slots) with some committed period of usage. Annual + # commitments renew by default. Commitments can be removed after their + # commitment end time passes. In order to remove annual commitment, its plan + # needs to be changed to monthly or flex first. # A capacity commitment resource exists as a child resource of the admin # project. class CapacityCommitment @@ -511,10 +511,10 @@ module Google include Google::Apis::Core::Hashable # Capacity commitment is a way to purchase compute capacity for BigQuery jobs - # (in the form of slots) with some committed period of usage. Monthly and - # annual commitments renew by default. Only flex commitments can be removed. In - # order to remove monthly or annual commitments, their plan needs to be changed - # to flex first. + # (in the form of slots) with some committed period of usage. Annual + # commitments renew by default. Commitments can be removed after their + # commitment end time passes. In order to remove annual commitment, its plan + # needs to be changed to monthly or flex first. # A capacity commitment resource exists as a child resource of the admin # project. # Corresponds to the JSON property `first` @@ -522,10 +522,10 @@ module Google attr_accessor :first # Capacity commitment is a way to purchase compute capacity for BigQuery jobs - # (in the form of slots) with some committed period of usage. Monthly and - # annual commitments renew by default. Only flex commitments can be removed. In - # order to remove monthly or annual commitments, their plan needs to be changed - # to flex first. + # (in the form of slots) with some committed period of usage. Annual + # commitments renew by default. Commitments can be removed after their + # commitment end time passes. In order to remove annual commitment, its plan + # needs to be changed to monthly or flex first. # A capacity commitment resource exists as a child resource of the admin # project. # Corresponds to the JSON property `second` diff --git a/generated/google/apis/bigqueryreservation_v1beta1.rb b/generated/google/apis/bigqueryreservation_v1beta1.rb index b5f6a3711..29aa6e257 100644 --- a/generated/google/apis/bigqueryreservation_v1beta1.rb +++ b/generated/google/apis/bigqueryreservation_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/bigquery/ module BigqueryreservationV1beta1 VERSION = 'V1beta1' - REVISION = '20200403' + REVISION = '20200410' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' diff --git a/generated/google/apis/bigqueryreservation_v1beta1/classes.rb b/generated/google/apis/bigqueryreservation_v1beta1/classes.rb index 082e8d067..aff64329c 100644 --- a/generated/google/apis/bigqueryreservation_v1beta1/classes.rb +++ b/generated/google/apis/bigqueryreservation_v1beta1/classes.rb @@ -130,10 +130,10 @@ module Google end # Capacity commitment is a way to purchase compute capacity for BigQuery jobs - # (in the form of slots) with some committed period of usage. Monthly and - # annual commitments renew by default. Only flex commitments can be removed. In - # order to remove monthly or annual commitments, their plan needs to be changed - # to flex first. + # (in the form of slots) with some committed period of usage. Annual + # commitments renew by default. Commitments can be removed after their + # commitment end time passes. In order to remove annual commitment, its plan + # needs to be changed to monthly or flex first. # A capacity commitment resource exists as a child resource of the admin # project. class CapacityCommitment @@ -469,10 +469,10 @@ module Google include Google::Apis::Core::Hashable # Capacity commitment is a way to purchase compute capacity for BigQuery jobs - # (in the form of slots) with some committed period of usage. Monthly and - # annual commitments renew by default. Only flex commitments can be removed. In - # order to remove monthly or annual commitments, their plan needs to be changed - # to flex first. + # (in the form of slots) with some committed period of usage. Annual + # commitments renew by default. Commitments can be removed after their + # commitment end time passes. In order to remove annual commitment, its plan + # needs to be changed to monthly or flex first. # A capacity commitment resource exists as a child resource of the admin # project. # Corresponds to the JSON property `first` @@ -480,10 +480,10 @@ module Google attr_accessor :first # Capacity commitment is a way to purchase compute capacity for BigQuery jobs - # (in the form of slots) with some committed period of usage. Monthly and - # annual commitments renew by default. Only flex commitments can be removed. In - # order to remove monthly or annual commitments, their plan needs to be changed - # to flex first. + # (in the form of slots) with some committed period of usage. Annual + # commitments renew by default. Commitments can be removed after their + # commitment end time passes. In order to remove annual commitment, its plan + # needs to be changed to monthly or flex first. # A capacity commitment resource exists as a child resource of the admin # project. # Corresponds to the JSON property `second` diff --git a/generated/google/apis/binaryauthorization_v1.rb b/generated/google/apis/binaryauthorization_v1.rb index b7904dce5..74b761ebc 100644 --- a/generated/google/apis/binaryauthorization_v1.rb +++ b/generated/google/apis/binaryauthorization_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/binary-authorization/ module BinaryauthorizationV1 VERSION = 'V1' - REVISION = '20200221' + REVISION = '20200501' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/binaryauthorization_v1/classes.rb b/generated/google/apis/binaryauthorization_v1/classes.rb index 02d79b4b7..96085b102 100644 --- a/generated/google/apis/binaryauthorization_v1/classes.rb +++ b/generated/google/apis/binaryauthorization_v1/classes.rb @@ -354,10 +354,13 @@ module Google # 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. - # Optionally, a `binding` can 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. + # 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": [ @@ -372,7 +375,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -445,6 +450,9 @@ module Google # 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 @@ -605,10 +613,13 @@ module Google # 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. - # Optionally, a `binding` can 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. + # 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": [ @@ -623,7 +634,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", diff --git a/generated/google/apis/binaryauthorization_v1/service.rb b/generated/google/apis/binaryauthorization_v1/service.rb index 80d6bf551..4211c2158 100644 --- a/generated/google/apis/binaryauthorization_v1/service.rb +++ b/generated/google/apis/binaryauthorization_v1/service.rb @@ -238,6 +238,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value 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). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -309,7 +312,7 @@ module Google # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. @@ -345,7 +348,7 @@ module Google # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. @@ -430,6 +433,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value 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). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -460,7 +466,7 @@ module Google # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. @@ -496,7 +502,7 @@ module Google # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. diff --git a/generated/google/apis/binaryauthorization_v1beta1.rb b/generated/google/apis/binaryauthorization_v1beta1.rb index 5e74610dd..fe33cda34 100644 --- a/generated/google/apis/binaryauthorization_v1beta1.rb +++ b/generated/google/apis/binaryauthorization_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/binary-authorization/ module BinaryauthorizationV1beta1 VERSION = 'V1beta1' - REVISION = '20200221' + REVISION = '20200501' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/binaryauthorization_v1beta1/classes.rb b/generated/google/apis/binaryauthorization_v1beta1/classes.rb index d6d7a5eb1..2b2d25f05 100644 --- a/generated/google/apis/binaryauthorization_v1beta1/classes.rb +++ b/generated/google/apis/binaryauthorization_v1beta1/classes.rb @@ -354,10 +354,13 @@ module Google # 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. - # Optionally, a `binding` can 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. + # 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": [ @@ -372,7 +375,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -445,6 +450,9 @@ module Google # 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 @@ -605,10 +613,13 @@ module Google # 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. - # Optionally, a `binding` can 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. + # 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": [ @@ -623,7 +634,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", diff --git a/generated/google/apis/binaryauthorization_v1beta1/service.rb b/generated/google/apis/binaryauthorization_v1beta1/service.rb index d6975cc62..27f9bf8c8 100644 --- a/generated/google/apis/binaryauthorization_v1beta1/service.rb +++ b/generated/google/apis/binaryauthorization_v1beta1/service.rb @@ -238,6 +238,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value 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). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -309,7 +312,7 @@ module Google # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. @@ -345,7 +348,7 @@ module Google # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. @@ -430,6 +433,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value 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). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -460,7 +466,7 @@ module Google # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. @@ -496,7 +502,7 @@ module Google # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. diff --git a/generated/google/apis/calendar_v3.rb b/generated/google/apis/calendar_v3.rb index 9ff73fc7e..9b761c2fe 100644 --- a/generated/google/apis/calendar_v3.rb +++ b/generated/google/apis/calendar_v3.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/google-apps/calendar/firstapp module CalendarV3 VERSION = 'V3' - REVISION = '20200315' + REVISION = '20200428' # See, edit, share, and permanently delete all the calendars you can access using Google Calendar AUTH_CALENDAR = 'https://www.googleapis.com/auth/calendar' diff --git a/generated/google/apis/calendar_v3/classes.rb b/generated/google/apis/calendar_v3/classes.rb index 22707886b..2a3f442f5 100644 --- a/generated/google/apis/calendar_v3/classes.rb +++ b/generated/google/apis/calendar_v3/classes.rb @@ -331,8 +331,8 @@ module Google # @return [String] attr_accessor :foreground_color - # Whether the calendar has been hidden from the list. Optional. The default is - # False. + # Whether the calendar has been hidden from the list. Optional. The attribute is + # only returned when the calendar is hidden, in which case the value is true. # Corresponds to the JSON property `hidden` # @return [Boolean] attr_accessor :hidden @@ -630,7 +630,7 @@ module Google # @return [String] attr_accessor :conference_id - # The conference solution, such as Hangouts or Hangouts Meet. + # The conference solution, such as Hangouts or Google Meet. # Unset for a conference with a failed create request. # Either conferenceSolution and at least one entryPoint, or createRequest is # required. @@ -841,7 +841,7 @@ module Google class CreateConferenceRequest include Google::Apis::Core::Hashable - # The conference solution, such as Hangouts or Hangouts Meet. + # The conference solution, such as Hangouts or Google Meet. # Corresponds to the JSON property `conferenceSolutionKey` # @return [Google::Apis::CalendarV3::ConferenceSolutionKey] attr_accessor :conference_solution_key @@ -1064,7 +1064,7 @@ module Google # @return [String] attr_accessor :color_id - # The conference-related information, such as details of a Hangouts Meet + # The conference-related information, such as details of a Google Meet # conference. To create new conference details use the createRequest field. To # persist your changes, remember to set the conferenceDataVersion request # parameter to 1 for all event modification requests. diff --git a/generated/google/apis/cloudasset_v1p1beta1.rb b/generated/google/apis/cloudasset_v1p1beta1.rb index 5df86de92..bcfb40f30 100644 --- a/generated/google/apis/cloudasset_v1p1beta1.rb +++ b/generated/google/apis/cloudasset_v1p1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/asset-inventory/docs/quickstart module CloudassetV1p1beta1 VERSION = 'V1p1beta1' - REVISION = '20200403' + REVISION = '20200410' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudasset_v1p1beta1/service.rb b/generated/google/apis/cloudasset_v1p1beta1/service.rb index 7853d028d..608cecd0b 100644 --- a/generated/google/apis/cloudasset_v1p1beta1/service.rb +++ b/generated/google/apis/cloudasset_v1p1beta1/service.rb @@ -60,6 +60,7 @@ module Google # * Organization number (such as "organizations/123") # * Folder number(such as "folders/1234") # * Project number (such as "projects/12345") + # * Project id (such as "projects/abc") # @param [Fixnum] page_size # Optional. The page size for search result pagination. Page size is capped at # 500 even @@ -120,6 +121,7 @@ module Google # * Organization number (such as "organizations/123") # * Folder number(such as "folders/1234") # * Project number (such as "projects/12345") + # * Project id (such as "projects/abc") # @param [Array, String] asset_types # Optional. A list of asset types that this request searches for. If empty, it # will diff --git a/generated/google/apis/osconfig_v1beta.rb b/generated/google/apis/cloudasset_v1p4beta1.rb similarity index 66% rename from generated/google/apis/osconfig_v1beta.rb rename to generated/google/apis/cloudasset_v1p4beta1.rb index de8b01ea1..7da598672 100644 --- a/generated/google/apis/osconfig_v1beta.rb +++ b/generated/google/apis/cloudasset_v1p4beta1.rb @@ -12,20 +12,19 @@ # See the License for the specific language governing permissions and # limitations under the License. -require 'google/apis/osconfig_v1beta/service.rb' -require 'google/apis/osconfig_v1beta/classes.rb' -require 'google/apis/osconfig_v1beta/representations.rb' +require 'google/apis/cloudasset_v1p4beta1/service.rb' +require 'google/apis/cloudasset_v1p4beta1/classes.rb' +require 'google/apis/cloudasset_v1p4beta1/representations.rb' module Google module Apis - # Cloud OS Config API + # Cloud Asset API # - # OS management tools that can be used for patch management, patch compliance, - # and configuration management on VM instances. + # The cloud asset API manages the history and inventory of cloud resources. # - # @see https://cloud.google.com/ - module OsconfigV1beta - VERSION = 'V1beta' + # @see https://cloud.google.com/asset-inventory/docs/quickstart + module CloudassetV1p4beta1 + VERSION = 'V1p4beta1' REVISION = '20200403' # View and manage your data across Google Cloud Platform services diff --git a/generated/google/apis/cloudasset_v1p4beta1/classes.rb b/generated/google/apis/cloudasset_v1p4beta1/classes.rb new file mode 100644 index 000000000..33c8ef544 --- /dev/null +++ b/generated/google/apis/cloudasset_v1p4beta1/classes.rb @@ -0,0 +1,924 @@ +# 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 CloudassetV1p4beta1 + + # Specifies roles and/or permissions to analyze, to determine both the + # identities possessing them and the resources they control. If multiple + # values are specified, results will include identities and resources + # matching any of them. + class AccessSelector + include Google::Apis::Core::Hashable + + # Optional. The permissions to appear in result. + # Corresponds to the JSON property `permissions` + # @return [Array] + attr_accessor :permissions + + # Optional. The roles to appear in result. + # Corresponds to the JSON property `roles` + # @return [Array] + attr_accessor :roles + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @permissions = args[:permissions] if args.key?(:permissions) + @roles = args[:roles] if args.key?(:roles) + end + end + + # A response message for AssetService.AnalyzeIamPolicy. + class AnalyzeIamPolicyResponse + include Google::Apis::Core::Hashable + + # Represents whether all entries in the main_analysis and + # service_account_impersonation_analysis have been fully explored to + # answer the query in the request. + # Corresponds to the JSON property `fullyExplored` + # @return [Boolean] + attr_accessor :fully_explored + alias_method :fully_explored?, :fully_explored + + # An analysis message to group the query and results. + # Corresponds to the JSON property `mainAnalysis` + # @return [Google::Apis::CloudassetV1p4beta1::IamPolicyAnalysis] + attr_accessor :main_analysis + + # A list of non-critical errors happened during the request handling to + # explain why `fully_explored` is false, or empty if no error happened. + # Corresponds to the JSON property `nonCriticalErrors` + # @return [Array] + attr_accessor :non_critical_errors + + # The service account impersonation analysis if + # AnalyzeIamPolicyRequest.analyze_service_account_impersonation is + # enabled. + # Corresponds to the JSON property `serviceAccountImpersonationAnalysis` + # @return [Array] + attr_accessor :service_account_impersonation_analysis + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @fully_explored = args[:fully_explored] if args.key?(:fully_explored) + @main_analysis = args[:main_analysis] if args.key?(:main_analysis) + @non_critical_errors = args[:non_critical_errors] if args.key?(:non_critical_errors) + @service_account_impersonation_analysis = args[:service_account_impersonation_analysis] if args.key?(:service_account_impersonation_analysis) + 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::CloudassetV1p4beta1::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] + 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 + + # A request message for AssetService.ExportIamPolicyAnalysis. + class ExportIamPolicyAnalysisRequest + include Google::Apis::Core::Hashable + + # IAM policy analysis query message. + # Corresponds to the JSON property `analysisQuery` + # @return [Google::Apis::CloudassetV1p4beta1::IamPolicyAnalysisQuery] + attr_accessor :analysis_query + + # Contains request options. + # Corresponds to the JSON property `options` + # @return [Google::Apis::CloudassetV1p4beta1::Options] + attr_accessor :options + + # Output configuration for export IAM policy analysis destination. + # Corresponds to the JSON property `outputConfig` + # @return [Google::Apis::CloudassetV1p4beta1::IamPolicyAnalysisOutputConfig] + attr_accessor :output_config + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @analysis_query = args[:analysis_query] if args.key?(:analysis_query) + @options = args[:options] if args.key?(:options) + @output_config = args[:output_config] if args.key?(:output_config) + 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 + + # A Cloud Storage location. + class GcsDestination + include Google::Apis::Core::Hashable + + # Required. The uri of the Cloud Storage object. It's the same uri that is used + # by + # gsutil. For example: "gs://bucket_name/object_name". See [Viewing and + # Editing Object + # Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) + # for more information. + # Corresponds to the JSON property `uri` + # @return [String] + attr_accessor :uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @uri = args[:uri] if args.key?(:uri) + end + end + + # A role or permission that appears in an access control list. + class GoogleCloudAssetV1p4beta1Access + include Google::Apis::Core::Hashable + + # Represents analysis state of each node in the result graph or non-critical + # errors in the response. + # Corresponds to the JSON property `analysisState` + # @return [Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1AnalysisState] + attr_accessor :analysis_state + + # The permission. + # Corresponds to the JSON property `permission` + # @return [String] + attr_accessor :permission + + # The role. + # 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) + @analysis_state = args[:analysis_state] if args.key?(:analysis_state) + @permission = args[:permission] if args.key?(:permission) + @role = args[:role] if args.key?(:role) + end + end + + # An access control list, derived from the above IAM policy binding, which + # contains a set of resources and accesses. May include one + # item from each set to compose an access control entry. + # NOTICE that there could be multiple access control lists for one IAM policy + # binding. The access control lists are created based on resource and access + # combinations. + # For example, assume we have the following cases in one IAM policy binding: + # - Permission P1 and P2 apply to resource R1 and R2; + # - Permission P3 applies to resource R2 and R3; + # This will result in the following access control lists: + # - AccessControlList 1: [R1, R2], [P1, P2] + # - AccessControlList 2: [R2, R3], [P3] + class GoogleCloudAssetV1p4beta1AccessControlList + include Google::Apis::Core::Hashable + + # The accesses that match one of the following conditions: + # - The access_selector, if it is specified in request; + # - Otherwise, access specifiers reachable from the policy binding's role. + # Corresponds to the JSON property `accesses` + # @return [Array] + attr_accessor :accesses + + # Resource edges of the graph starting from the policy attached + # resource to any descendant resources. The Edge.source_node contains + # the full resource name of a parent resource and Edge.target_node + # contains the full resource name of a child resource. This field is + # present only if the output_resource_edges option is enabled in request. + # Corresponds to the JSON property `resourceEdges` + # @return [Array] + attr_accessor :resource_edges + + # The resources that match one of the following conditions: + # - The resource_selector, if it is specified in request; + # - Otherwise, resources reachable from the policy attached resource. + # Corresponds to the JSON property `resources` + # @return [Array] + attr_accessor :resources + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @accesses = args[:accesses] if args.key?(:accesses) + @resource_edges = args[:resource_edges] if args.key?(:resource_edges) + @resources = args[:resources] if args.key?(:resources) + end + end + + # Represents analysis state of each node in the result graph or non-critical + # errors in the response. + class GoogleCloudAssetV1p4beta1AnalysisState + include Google::Apis::Core::Hashable + + # The human-readable description of the cause of failure. + # Corresponds to the JSON property `cause` + # @return [String] + attr_accessor :cause + + # The Google standard error code that best describes the state. + # For example: + # - OK means the node has been successfully explored; + # - PERMISSION_DENIED means an access denied error is encountered; + # - DEADLINE_EXCEEDED means the node hasn't been explored in time; + # Corresponds to the JSON property `code` + # @return [String] + attr_accessor :code + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cause = args[:cause] if args.key?(:cause) + @code = args[:code] if args.key?(:code) + end + end + + # A directional edge. + class GoogleCloudAssetV1p4beta1Edge + include Google::Apis::Core::Hashable + + # The source node of the edge. + # Corresponds to the JSON property `sourceNode` + # @return [String] + attr_accessor :source_node + + # The target node of the edge. + # Corresponds to the JSON property `targetNode` + # @return [String] + attr_accessor :target_node + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @source_node = args[:source_node] if args.key?(:source_node) + @target_node = args[:target_node] if args.key?(:target_node) + end + end + + # An identity that appears in an access control list. + class GoogleCloudAssetV1p4beta1Identity + include Google::Apis::Core::Hashable + + # Represents analysis state of each node in the result graph or non-critical + # errors in the response. + # Corresponds to the JSON property `analysisState` + # @return [Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1AnalysisState] + attr_accessor :analysis_state + + # The identity name in any form of members appear in + # [IAM policy + # binding](https://cloud.google.com/iam/reference/rest/v1/Binding), such + # as: + # - user:foo@google.com + # - group:group1@google.com + # - serviceAccount:s1@prj1.iam.gserviceaccount.com + # - projectOwner:some_project_id + # - domain:google.com + # - allUsers + # - etc. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @analysis_state = args[:analysis_state] if args.key?(:analysis_state) + @name = args[:name] if args.key?(:name) + end + end + + # + class GoogleCloudAssetV1p4beta1IdentityList + include Google::Apis::Core::Hashable + + # Group identity edges of the graph starting from the binding's + # group members to any node of the identities. The Edge.source_node + # contains a group, such as "group:parent@google.com". The + # Edge.target_node contains a member of the group, + # such as "group:child@google.com" or "user:foo@google.com". + # This field is present only if the output_group_edges option is enabled in + # request. + # Corresponds to the JSON property `groupEdges` + # @return [Array] + attr_accessor :group_edges + + # Only the identities that match one of the following conditions will be + # presented: + # - The identity_selector, if it is specified in request; + # - Otherwise, identities reachable from the policy binding's members. + # Corresponds to the JSON property `identities` + # @return [Array] + attr_accessor :identities + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @group_edges = args[:group_edges] if args.key?(:group_edges) + @identities = args[:identities] if args.key?(:identities) + end + end + + # A GCP resource that appears in an access control list. + class GoogleCloudAssetV1p4beta1Resource + include Google::Apis::Core::Hashable + + # Represents analysis state of each node in the result graph or non-critical + # errors in the response. + # Corresponds to the JSON property `analysisState` + # @return [Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1AnalysisState] + attr_accessor :analysis_state + + # The [full resource name](https://aip.dev/122#full-resource-names). + # Corresponds to the JSON property `fullResourceName` + # @return [String] + attr_accessor :full_resource_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @analysis_state = args[:analysis_state] if args.key?(:analysis_state) + @full_resource_name = args[:full_resource_name] if args.key?(:full_resource_name) + end + end + + # An analysis message to group the query and results. + class IamPolicyAnalysis + include Google::Apis::Core::Hashable + + # IAM policy analysis query message. + # Corresponds to the JSON property `analysisQuery` + # @return [Google::Apis::CloudassetV1p4beta1::IamPolicyAnalysisQuery] + attr_accessor :analysis_query + + # A list of IamPolicyAnalysisResult that matches the analysis query, or + # empty if no result is found. + # Corresponds to the JSON property `analysisResults` + # @return [Array] + attr_accessor :analysis_results + + # Represents whether all entries in the analysis_results have been + # fully explored to answer the query. + # Corresponds to the JSON property `fullyExplored` + # @return [Boolean] + attr_accessor :fully_explored + alias_method :fully_explored?, :fully_explored + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @analysis_query = args[:analysis_query] if args.key?(:analysis_query) + @analysis_results = args[:analysis_results] if args.key?(:analysis_results) + @fully_explored = args[:fully_explored] if args.key?(:fully_explored) + end + end + + # Output configuration for export IAM policy analysis destination. + class IamPolicyAnalysisOutputConfig + include Google::Apis::Core::Hashable + + # A Cloud Storage location. + # Corresponds to the JSON property `gcsDestination` + # @return [Google::Apis::CloudassetV1p4beta1::GcsDestination] + attr_accessor :gcs_destination + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @gcs_destination = args[:gcs_destination] if args.key?(:gcs_destination) + end + end + + # IAM policy analysis query message. + class IamPolicyAnalysisQuery + include Google::Apis::Core::Hashable + + # Specifies roles and/or permissions to analyze, to determine both the + # identities possessing them and the resources they control. If multiple + # values are specified, results will include identities and resources + # matching any of them. + # Corresponds to the JSON property `accessSelector` + # @return [Google::Apis::CloudassetV1p4beta1::AccessSelector] + attr_accessor :access_selector + + # Specifies an identity for which to determine resource access, based on + # roles assigned either directly to them or to the groups they belong to, + # directly or indirectly. + # Corresponds to the JSON property `identitySelector` + # @return [Google::Apis::CloudassetV1p4beta1::IdentitySelector] + attr_accessor :identity_selector + + # Required. The relative name of the root asset. Only resources and IAM policies + # within + # the parent will be analyzed. This can only be an organization number (such + # as "organizations/123") or a folder number (such as "folders/123"). + # Corresponds to the JSON property `parent` + # @return [String] + attr_accessor :parent + + # Specifies the resource to analyze for access policies, which may be set + # directly on the resource, or on ancestors such as organizations, folders or + # projects. At least one of ResourceSelector, IdentitySelector or + # AccessSelector must be specified in a request. + # Corresponds to the JSON property `resourceSelector` + # @return [Google::Apis::CloudassetV1p4beta1::ResourceSelector] + attr_accessor :resource_selector + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @access_selector = args[:access_selector] if args.key?(:access_selector) + @identity_selector = args[:identity_selector] if args.key?(:identity_selector) + @parent = args[:parent] if args.key?(:parent) + @resource_selector = args[:resource_selector] if args.key?(:resource_selector) + end + end + + # IAM Policy analysis result, consisting of one IAM policy binding and derived + # access control lists. + class IamPolicyAnalysisResult + include Google::Apis::Core::Hashable + + # The access control lists derived from the iam_binding that match or + # potentially match resource and access selectors specified in the request. + # Corresponds to the JSON property `accessControlLists` + # @return [Array] + attr_accessor :access_control_lists + + # The full name of the resource to which the iam_binding policy attaches. + # Corresponds to the JSON property `attachedResourceFullName` + # @return [String] + attr_accessor :attached_resource_full_name + + # Represents whether all nodes in the transitive closure of the + # iam_binding node have been explored. + # Corresponds to the JSON property `fullyExplored` + # @return [Boolean] + attr_accessor :fully_explored + alias_method :fully_explored?, :fully_explored + + # Associates `members` with a `role`. + # Corresponds to the JSON property `iamBinding` + # @return [Google::Apis::CloudassetV1p4beta1::Binding] + attr_accessor :iam_binding + + # The identity list derived from members of the iam_binding that match or + # potentially match identity selector specified in the request. + # Corresponds to the JSON property `identityList` + # @return [Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1IdentityList] + attr_accessor :identity_list + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @access_control_lists = args[:access_control_lists] if args.key?(:access_control_lists) + @attached_resource_full_name = args[:attached_resource_full_name] if args.key?(:attached_resource_full_name) + @fully_explored = args[:fully_explored] if args.key?(:fully_explored) + @iam_binding = args[:iam_binding] if args.key?(:iam_binding) + @identity_list = args[:identity_list] if args.key?(:identity_list) + end + end + + # Specifies an identity for which to determine resource access, based on + # roles assigned either directly to them or to the groups they belong to, + # directly or indirectly. + class IdentitySelector + include Google::Apis::Core::Hashable + + # Required. The identity appear in the form of members in + # [IAM policy + # binding](https://cloud.google.com/iam/reference/rest/v1/Binding). + # Corresponds to the JSON property `identity` + # @return [String] + attr_accessor :identity + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @identity = args[:identity] if args.key?(:identity) + end + end + + # This resource represents a long-running operation that is the result of a + # network API call. + class Operation + include Google::Apis::Core::Hashable + + # If the value is `false`, it means the operation is still in progress. + # If `true`, the operation is completed, and either `error` or `response` is + # available. + # Corresponds to the JSON property `done` + # @return [Boolean] + attr_accessor :done + alias_method :done?, :done + + # 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). Each `Status` message contains + # three pieces of data: error code, error message, and error details. + # You can find out more about this error model and how to work with it in the + # [API Design Guide](https://cloud.google.com/apis/design/errors). + # Corresponds to the JSON property `error` + # @return [Google::Apis::CloudassetV1p4beta1::Status] + attr_accessor :error + + # Service-specific metadata associated with the operation. It typically + # contains progress information and common metadata such as create time. + # Some services might not provide such metadata. Any method that returns a + # long-running operation should document the metadata type, if any. + # Corresponds to the JSON property `metadata` + # @return [Hash] + attr_accessor :metadata + + # The server-assigned name, which is only unique within the same service that + # originally returns it. If you use the default HTTP mapping, the + # `name` should be a resource name ending with `operations/`unique_id``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The normal response of the operation in case of success. If the original + # method returns no data on success, such as `Delete`, the response is + # `google.protobuf.Empty`. If the original method is standard + # `Get`/`Create`/`Update`, the response should be the resource. For other + # methods, the response should have the type `XxxResponse`, where `Xxx` + # is the original method name. For example, if the original method name + # is `TakeSnapshot()`, the inferred response type is + # `TakeSnapshotResponse`. + # Corresponds to the JSON property `response` + # @return [Hash] + attr_accessor :response + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @done = args[:done] if args.key?(:done) + @error = args[:error] if args.key?(:error) + @metadata = args[:metadata] if args.key?(:metadata) + @name = args[:name] if args.key?(:name) + @response = args[:response] if args.key?(:response) + end + end + + # Contains request options. + class Options + include Google::Apis::Core::Hashable + + # Optional. If true, the response will include access analysis from identities + # to + # resources via service account impersonation. This is a very expensive + # operation, because many derived queries will be executed. + # For example, if the request analyzes for which resources user A has + # permission P, and there's an IAM policy states user A has + # iam.serviceAccounts.getAccessToken permission to a service account SA, + # and there's another IAM policy states service account SA has permission P + # to a GCP folder F, then user A potentially has access to the GCP folder + # F. And those advanced analysis results will be included in + # AnalyzeIamPolicyResponse.service_account_impersonation_analysis. + # Another example, if the request analyzes for who has + # permission P to a GCP folder F, and there's an IAM policy states user A + # has iam.serviceAccounts.actAs permission to a service account SA, and + # there's another IAM policy states service account SA has permission P to + # the GCP folder F, then user A potentially has access to the GCP folder + # F. And those advanced analysis results will be included in + # AnalyzeIamPolicyResponse.service_account_impersonation_analysis. + # Default is false. + # Corresponds to the JSON property `analyzeServiceAccountImpersonation` + # @return [Boolean] + attr_accessor :analyze_service_account_impersonation + alias_method :analyze_service_account_impersonation?, :analyze_service_account_impersonation + + # Optional. If true, the identities section of the result will expand any + # Google groups appearing in an IAM policy binding. + # If identity_selector is specified, the identity in the result will + # be determined by the selector, and this flag will have no effect. + # Default is false. + # Corresponds to the JSON property `expandGroups` + # @return [Boolean] + attr_accessor :expand_groups + alias_method :expand_groups?, :expand_groups + + # Optional. If true, the resource section of the result will expand any + # resource attached to an IAM policy to include resources lower in the + # resource hierarchy. + # For example, if the request analyzes for which resources user A has + # permission P, and the results include an IAM policy with P on a GCP + # folder, the results will also include resources in that folder with + # permission P. + # If resource_selector is specified, the resource section of the result + # will be determined by the selector, and this flag will have no effect. + # Default is false. + # Corresponds to the JSON property `expandResources` + # @return [Boolean] + attr_accessor :expand_resources + alias_method :expand_resources?, :expand_resources + + # Optional. If true, the access section of result will expand any roles + # appearing in IAM policy bindings to include their permissions. + # If access_selector is specified, the access section of the result + # will be determined by the selector, and this flag will have no effect. + # Default is false. + # Corresponds to the JSON property `expandRoles` + # @return [Boolean] + attr_accessor :expand_roles + alias_method :expand_roles?, :expand_roles + + # Optional. If true, the result will output group identity edges, starting + # from the binding's group members, to any expanded identities. + # Default is false. + # Corresponds to the JSON property `outputGroupEdges` + # @return [Boolean] + attr_accessor :output_group_edges + alias_method :output_group_edges?, :output_group_edges + + # Optional. If true, the result will output resource edges, starting + # from the policy attached resource, to any expanded resources. + # Default is false. + # Corresponds to the JSON property `outputResourceEdges` + # @return [Boolean] + attr_accessor :output_resource_edges + alias_method :output_resource_edges?, :output_resource_edges + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @analyze_service_account_impersonation = args[:analyze_service_account_impersonation] if args.key?(:analyze_service_account_impersonation) + @expand_groups = args[:expand_groups] if args.key?(:expand_groups) + @expand_resources = args[:expand_resources] if args.key?(:expand_resources) + @expand_roles = args[:expand_roles] if args.key?(:expand_roles) + @output_group_edges = args[:output_group_edges] if args.key?(:output_group_edges) + @output_resource_edges = args[:output_resource_edges] if args.key?(:output_resource_edges) + end + end + + # Specifies the resource to analyze for access policies, which may be set + # directly on the resource, or on ancestors such as organizations, folders or + # projects. At least one of ResourceSelector, IdentitySelector or + # AccessSelector must be specified in a request. + class ResourceSelector + include Google::Apis::Core::Hashable + + # Required. The [full resource + # name](https://cloud.google.com/apis/design/resource_names#full_resource_name) + # . + # Corresponds to the JSON property `fullResourceName` + # @return [String] + attr_accessor :full_resource_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @full_resource_name = args[:full_resource_name] if args.key?(:full_resource_name) + end + end + + # 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). Each `Status` message contains + # three pieces of data: error code, error message, and error details. + # You can find out more about this error model and how to work with it in the + # [API Design Guide](https://cloud.google.com/apis/design/errors). + class Status + include Google::Apis::Core::Hashable + + # The status code, which should be an enum value of google.rpc.Code. + # Corresponds to the JSON property `code` + # @return [Fixnum] + attr_accessor :code + + # A list of messages that carry the error details. There is a common set of + # message types for APIs to use. + # Corresponds to the JSON property `details` + # @return [Array>] + attr_accessor :details + + # 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` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @details = args[:details] if args.key?(:details) + @message = args[:message] if args.key?(:message) + end + end + end + end +end diff --git a/generated/google/apis/cloudasset_v1p4beta1/representations.rb b/generated/google/apis/cloudasset_v1p4beta1/representations.rb new file mode 100644 index 000000000..cb951d9c5 --- /dev/null +++ b/generated/google/apis/cloudasset_v1p4beta1/representations.rb @@ -0,0 +1,377 @@ +# 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 CloudassetV1p4beta1 + + class AccessSelector + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AnalyzeIamPolicyResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Binding + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ExportIamPolicyAnalysisRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Expr + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GcsDestination + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudAssetV1p4beta1Access + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudAssetV1p4beta1AccessControlList + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudAssetV1p4beta1AnalysisState + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudAssetV1p4beta1Edge + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudAssetV1p4beta1Identity + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudAssetV1p4beta1IdentityList + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudAssetV1p4beta1Resource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IamPolicyAnalysis + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IamPolicyAnalysisOutputConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IamPolicyAnalysisQuery + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IamPolicyAnalysisResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IdentitySelector + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Operation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Options + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ResourceSelector + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Status + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AccessSelector + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :permissions, as: 'permissions' + collection :roles, as: 'roles' + end + end + + class AnalyzeIamPolicyResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :fully_explored, as: 'fullyExplored' + property :main_analysis, as: 'mainAnalysis', class: Google::Apis::CloudassetV1p4beta1::IamPolicyAnalysis, decorator: Google::Apis::CloudassetV1p4beta1::IamPolicyAnalysis::Representation + + collection :non_critical_errors, as: 'nonCriticalErrors', class: Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1AnalysisState, decorator: Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1AnalysisState::Representation + + collection :service_account_impersonation_analysis, as: 'serviceAccountImpersonationAnalysis', class: Google::Apis::CloudassetV1p4beta1::IamPolicyAnalysis, decorator: Google::Apis::CloudassetV1p4beta1::IamPolicyAnalysis::Representation + + end + end + + class Binding + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :condition, as: 'condition', class: Google::Apis::CloudassetV1p4beta1::Expr, decorator: Google::Apis::CloudassetV1p4beta1::Expr::Representation + + collection :members, as: 'members' + property :role, as: 'role' + end + end + + class ExportIamPolicyAnalysisRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :analysis_query, as: 'analysisQuery', class: Google::Apis::CloudassetV1p4beta1::IamPolicyAnalysisQuery, decorator: Google::Apis::CloudassetV1p4beta1::IamPolicyAnalysisQuery::Representation + + property :options, as: 'options', class: Google::Apis::CloudassetV1p4beta1::Options, decorator: Google::Apis::CloudassetV1p4beta1::Options::Representation + + property :output_config, as: 'outputConfig', class: Google::Apis::CloudassetV1p4beta1::IamPolicyAnalysisOutputConfig, decorator: Google::Apis::CloudassetV1p4beta1::IamPolicyAnalysisOutputConfig::Representation + + end + end + + class Expr + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :expression, as: 'expression' + property :location, as: 'location' + property :title, as: 'title' + end + end + + class GcsDestination + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :uri, as: 'uri' + end + end + + class GoogleCloudAssetV1p4beta1Access + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :analysis_state, as: 'analysisState', class: Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1AnalysisState, decorator: Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1AnalysisState::Representation + + property :permission, as: 'permission' + property :role, as: 'role' + end + end + + class GoogleCloudAssetV1p4beta1AccessControlList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :accesses, as: 'accesses', class: Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1Access, decorator: Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1Access::Representation + + collection :resource_edges, as: 'resourceEdges', class: Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1Edge, decorator: Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1Edge::Representation + + collection :resources, as: 'resources', class: Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1Resource, decorator: Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1Resource::Representation + + end + end + + class GoogleCloudAssetV1p4beta1AnalysisState + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cause, as: 'cause' + property :code, as: 'code' + end + end + + class GoogleCloudAssetV1p4beta1Edge + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :source_node, as: 'sourceNode' + property :target_node, as: 'targetNode' + end + end + + class GoogleCloudAssetV1p4beta1Identity + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :analysis_state, as: 'analysisState', class: Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1AnalysisState, decorator: Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1AnalysisState::Representation + + property :name, as: 'name' + end + end + + class GoogleCloudAssetV1p4beta1IdentityList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :group_edges, as: 'groupEdges', class: Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1Edge, decorator: Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1Edge::Representation + + collection :identities, as: 'identities', class: Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1Identity, decorator: Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1Identity::Representation + + end + end + + class GoogleCloudAssetV1p4beta1Resource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :analysis_state, as: 'analysisState', class: Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1AnalysisState, decorator: Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1AnalysisState::Representation + + property :full_resource_name, as: 'fullResourceName' + end + end + + class IamPolicyAnalysis + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :analysis_query, as: 'analysisQuery', class: Google::Apis::CloudassetV1p4beta1::IamPolicyAnalysisQuery, decorator: Google::Apis::CloudassetV1p4beta1::IamPolicyAnalysisQuery::Representation + + collection :analysis_results, as: 'analysisResults', class: Google::Apis::CloudassetV1p4beta1::IamPolicyAnalysisResult, decorator: Google::Apis::CloudassetV1p4beta1::IamPolicyAnalysisResult::Representation + + property :fully_explored, as: 'fullyExplored' + end + end + + class IamPolicyAnalysisOutputConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :gcs_destination, as: 'gcsDestination', class: Google::Apis::CloudassetV1p4beta1::GcsDestination, decorator: Google::Apis::CloudassetV1p4beta1::GcsDestination::Representation + + end + end + + class IamPolicyAnalysisQuery + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :access_selector, as: 'accessSelector', class: Google::Apis::CloudassetV1p4beta1::AccessSelector, decorator: Google::Apis::CloudassetV1p4beta1::AccessSelector::Representation + + property :identity_selector, as: 'identitySelector', class: Google::Apis::CloudassetV1p4beta1::IdentitySelector, decorator: Google::Apis::CloudassetV1p4beta1::IdentitySelector::Representation + + property :parent, as: 'parent' + property :resource_selector, as: 'resourceSelector', class: Google::Apis::CloudassetV1p4beta1::ResourceSelector, decorator: Google::Apis::CloudassetV1p4beta1::ResourceSelector::Representation + + end + end + + class IamPolicyAnalysisResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :access_control_lists, as: 'accessControlLists', class: Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1AccessControlList, decorator: Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1AccessControlList::Representation + + property :attached_resource_full_name, as: 'attachedResourceFullName' + property :fully_explored, as: 'fullyExplored' + property :iam_binding, as: 'iamBinding', class: Google::Apis::CloudassetV1p4beta1::Binding, decorator: Google::Apis::CloudassetV1p4beta1::Binding::Representation + + property :identity_list, as: 'identityList', class: Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1IdentityList, decorator: Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1IdentityList::Representation + + end + end + + class IdentitySelector + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :identity, as: 'identity' + end + end + + class Operation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :done, as: 'done' + property :error, as: 'error', class: Google::Apis::CloudassetV1p4beta1::Status, decorator: Google::Apis::CloudassetV1p4beta1::Status::Representation + + hash :metadata, as: 'metadata' + property :name, as: 'name' + hash :response, as: 'response' + end + end + + class Options + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :analyze_service_account_impersonation, as: 'analyzeServiceAccountImpersonation' + property :expand_groups, as: 'expandGroups' + property :expand_resources, as: 'expandResources' + property :expand_roles, as: 'expandRoles' + property :output_group_edges, as: 'outputGroupEdges' + property :output_resource_edges, as: 'outputResourceEdges' + end + end + + class ResourceSelector + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :full_resource_name, as: 'fullResourceName' + end + end + + class Status + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :details, as: 'details' + property :message, as: 'message' + end + end + end + end +end diff --git a/generated/google/apis/cloudasset_v1p4beta1/service.rb b/generated/google/apis/cloudasset_v1p4beta1/service.rb new file mode 100644 index 000000000..c3d1a1a50 --- /dev/null +++ b/generated/google/apis/cloudasset_v1p4beta1/service.rb @@ -0,0 +1,217 @@ +# 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 '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 CloudassetV1p4beta1 + # Cloud Asset API + # + # The cloud asset API manages the history and inventory of cloud resources. + # + # @example + # require 'google/apis/cloudasset_v1p4beta1' + # + # Cloudasset = Google::Apis::CloudassetV1p4beta1 # Alias the module + # service = Cloudasset::CloudAssetService.new + # + # @see https://cloud.google.com/asset-inventory/docs/quickstart + class CloudAssetService < Google::Apis::Core::BaseService + # @return [String] + # API key. Your API key identifies your project and provides you with API access, + # quota, and reports. Required unless you provide an OAuth 2.0 token. + attr_accessor :key + + # @return [String] + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + attr_accessor :quota_user + + def initialize + super('https://cloudasset.googleapis.com/', '') + @batch_path = 'batch' + end + + # Analyzes IAM policies based on the specified request. Returns + # a list of IamPolicyAnalysisResult matching the request. + # @param [String] parent + # Required. The relative name of the root asset. Only resources and IAM policies + # within + # the parent will be analyzed. This can only be an organization number (such + # as "organizations/123") or a folder number (such as "folders/123"). + # @param [Array, String] analysis_query_access_selector_permissions + # Optional. The permissions to appear in result. + # @param [Array, String] analysis_query_access_selector_roles + # Optional. The roles to appear in result. + # @param [String] analysis_query_identity_selector_identity + # Required. The identity appear in the form of members in + # [IAM policy + # binding](https://cloud.google.com/iam/reference/rest/v1/Binding). + # @param [String] analysis_query_resource_selector_full_resource_name + # Required. The [full resource + # name](https://cloud.google.com/apis/design/resource_names#full_resource_name) + # . + # @param [Boolean] options_analyze_service_account_impersonation + # Optional. If true, the response will include access analysis from identities + # to + # resources via service account impersonation. This is a very expensive + # operation, because many derived queries will be executed. We highly + # recommend you use ExportIamPolicyAnalysis rpc instead. + # For example, if the request analyzes for which resources user A has + # permission P, and there's an IAM policy states user A has + # iam.serviceAccounts.getAccessToken permission to a service account SA, + # and there's another IAM policy states service account SA has permission P + # to a GCP folder F, then user A potentially has access to the GCP folder + # F. And those advanced analysis results will be included in + # AnalyzeIamPolicyResponse.service_account_impersonation_analysis. + # Another example, if the request analyzes for who has + # permission P to a GCP folder F, and there's an IAM policy states user A + # has iam.serviceAccounts.actAs permission to a service account SA, and + # there's another IAM policy states service account SA has permission P to + # the GCP folder F, then user A potentially has access to the GCP folder + # F. And those advanced analysis results will be included in + # AnalyzeIamPolicyResponse.service_account_impersonation_analysis. + # Default is false. + # @param [String] options_execution_timeout + # Optional. Amount of time executable has to complete. See JSON representation + # of + # [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json). + # If this field is set with a value less than the RPC deadline, and the + # execution of your query hasn't finished in the specified + # execution timeout, you will get a response with partial result. + # Otherwise, your query's execution will continue until the RPC deadline. + # If it's not finished until then, you will get a DEADLINE_EXCEEDED error. + # Default is empty. + # @param [Boolean] options_expand_groups + # Optional. If true, the identities section of the result will expand any + # Google groups appearing in an IAM policy binding. + # If identity_selector is specified, the identity in the result will + # be determined by the selector, and this flag will have no effect. + # Default is false. + # @param [Boolean] options_expand_resources + # Optional. If true, the resource section of the result will expand any + # resource attached to an IAM policy to include resources lower in the + # resource hierarchy. + # For example, if the request analyzes for which resources user A has + # permission P, and the results include an IAM policy with P on a GCP + # folder, the results will also include resources in that folder with + # permission P. + # If resource_selector is specified, the resource section of the result + # will be determined by the selector, and this flag will have no effect. + # Default is false. + # @param [Boolean] options_expand_roles + # Optional. If true, the access section of result will expand any roles + # appearing in IAM policy bindings to include their permissions. + # If access_selector is specified, the access section of the result + # will be determined by the selector, and this flag will have no effect. + # Default is false. + # @param [Boolean] options_output_group_edges + # Optional. If true, the result will output group identity edges, starting + # from the binding's group members, to any expanded identities. + # Default is false. + # @param [Boolean] options_output_resource_edges + # Optional. If true, the result will output resource edges, starting + # from the policy attached resource, to any expanded resources. + # Default is false. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudassetV1p4beta1::AnalyzeIamPolicyResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudassetV1p4beta1::AnalyzeIamPolicyResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def analyze_iam_policy(parent, analysis_query_access_selector_permissions: nil, analysis_query_access_selector_roles: nil, analysis_query_identity_selector_identity: nil, analysis_query_resource_selector_full_resource_name: nil, options_analyze_service_account_impersonation: nil, options_execution_timeout: nil, options_expand_groups: nil, options_expand_resources: nil, options_expand_roles: nil, options_output_group_edges: nil, options_output_resource_edges: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1p4beta1/{+parent}:analyzeIamPolicy', options) + command.response_representation = Google::Apis::CloudassetV1p4beta1::AnalyzeIamPolicyResponse::Representation + command.response_class = Google::Apis::CloudassetV1p4beta1::AnalyzeIamPolicyResponse + command.params['parent'] = parent unless parent.nil? + command.query['analysisQuery.accessSelector.permissions'] = analysis_query_access_selector_permissions unless analysis_query_access_selector_permissions.nil? + command.query['analysisQuery.accessSelector.roles'] = analysis_query_access_selector_roles unless analysis_query_access_selector_roles.nil? + command.query['analysisQuery.identitySelector.identity'] = analysis_query_identity_selector_identity unless analysis_query_identity_selector_identity.nil? + command.query['analysisQuery.resourceSelector.fullResourceName'] = analysis_query_resource_selector_full_resource_name unless analysis_query_resource_selector_full_resource_name.nil? + command.query['options.analyzeServiceAccountImpersonation'] = options_analyze_service_account_impersonation unless options_analyze_service_account_impersonation.nil? + command.query['options.executionTimeout'] = options_execution_timeout unless options_execution_timeout.nil? + command.query['options.expandGroups'] = options_expand_groups unless options_expand_groups.nil? + command.query['options.expandResources'] = options_expand_resources unless options_expand_resources.nil? + command.query['options.expandRoles'] = options_expand_roles unless options_expand_roles.nil? + command.query['options.outputGroupEdges'] = options_output_group_edges unless options_output_group_edges.nil? + command.query['options.outputResourceEdges'] = options_output_resource_edges unless options_output_resource_edges.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Exports IAM policy analysis based on the specified request. This API + # implements the google.longrunning.Operation API allowing you to keep + # track of the export. The metadata contains the request to help callers to + # map responses to requests. + # @param [String] parent + # Required. The relative name of the root asset. Only resources and IAM policies + # within + # the parent will be analyzed. This can only be an organization number (such + # as "organizations/123") or a folder number (such as "folders/123"). + # @param [Google::Apis::CloudassetV1p4beta1::ExportIamPolicyAnalysisRequest] export_iam_policy_analysis_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudassetV1p4beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudassetV1p4beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def export_iam_policy_analysis(parent, export_iam_policy_analysis_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1p4beta1/{+parent}:exportIamPolicyAnalysis', options) + command.request_representation = Google::Apis::CloudassetV1p4beta1::ExportIamPolicyAnalysisRequest::Representation + command.request_object = export_iam_policy_analysis_request_object + command.response_representation = Google::Apis::CloudassetV1p4beta1::Operation::Representation + command.response_class = Google::Apis::CloudassetV1p4beta1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/cloudbilling_v1.rb b/generated/google/apis/cloudbilling_v1.rb index c994e9a35..4f9db45b7 100644 --- a/generated/google/apis/cloudbilling_v1.rb +++ b/generated/google/apis/cloudbilling_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/billing/ module CloudbillingV1 VERSION = 'V1' - REVISION = '20200210' + REVISION = '20200503' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudbilling_v1/classes.rb b/generated/google/apis/cloudbilling_v1/classes.rb index 1fc1af74c..4d419672e 100644 --- a/generated/google/apis/cloudbilling_v1/classes.rb +++ b/generated/google/apis/cloudbilling_v1/classes.rb @@ -560,10 +560,13 @@ module Google # 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. - # Optionally, a `binding` can 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. + # 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": [ @@ -578,7 +581,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -656,6 +661,9 @@ module Google # 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 @@ -912,10 +920,13 @@ module Google # 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. - # Optionally, a `binding` can 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. + # 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": [ @@ -930,7 +941,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -968,8 +981,7 @@ module Google # 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" - # This field is only used by Cloud IAM. + # `paths: "bindings, etag"` # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask diff --git a/generated/google/apis/cloudbilling_v1/service.rb b/generated/google/apis/cloudbilling_v1/service.rb index 47cb5de35..51a36e081 100644 --- a/generated/google/apis/cloudbilling_v1/service.rb +++ b/generated/google/apis/cloudbilling_v1/service.rb @@ -134,6 +134,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value 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). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/cloudbuild_v1.rb b/generated/google/apis/cloudbuild_v1.rb index a4728a218..87df8e957 100644 --- a/generated/google/apis/cloudbuild_v1.rb +++ b/generated/google/apis/cloudbuild_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/cloud-build/docs/ module CloudbuildV1 VERSION = 'V1' - REVISION = '20200317' + REVISION = '20200505' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudbuild_v1/classes.rb b/generated/google/apis/cloudbuild_v1/classes.rb index 21355b92f..f2cb611a6 100644 --- a/generated/google/apis/cloudbuild_v1/classes.rb +++ b/generated/google/apis/cloudbuild_v1/classes.rb @@ -1029,8 +1029,8 @@ module Google # @return [String] attr_accessor :branch - # Whether to block builds on a "/gcbrun" comment from a repository admin or - # collaborator. + # Configure builds to run only when a repository owner or collaborator + # comments `/gcbrun`. # Corresponds to the JSON property `commentControl` # @return [String] attr_accessor :comment_control diff --git a/generated/google/apis/clouddebugger_v2.rb b/generated/google/apis/clouddebugger_v2.rb index c53a63367..2df4a366b 100644 --- a/generated/google/apis/clouddebugger_v2.rb +++ b/generated/google/apis/clouddebugger_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/debugger module ClouddebuggerV2 VERSION = 'V2' - REVISION = '20200313' + REVISION = '20200410' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/clouddebugger_v2/classes.rb b/generated/google/apis/clouddebugger_v2/classes.rb index 632500cb8..368dc4fc6 100644 --- a/generated/google/apis/clouddebugger_v2/classes.rb +++ b/generated/google/apis/clouddebugger_v2/classes.rb @@ -59,6 +59,12 @@ module Google # @return [String] attr_accessor :action + # The deadline for the breakpoint to stay in CANARY_ACTIVE state. The value + # is meaningless when the breakpoint is not in CANARY_ACTIVE state. + # Corresponds to the JSON property `canaryExpireTime` + # @return [String] + attr_accessor :canary_expire_time + # Condition that triggers the breakpoint. # The condition is a compound boolean expression composed using expressions # in a programming language at the source location. @@ -141,6 +147,11 @@ module Google # @return [Array] attr_accessor :stack_frames + # The current state of the breakpoint. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + # Represents a contextual status message. # The message can indicate an error or informational status, and refer to # specific parts of the containing object. @@ -177,6 +188,7 @@ module Google # Update properties of this object def update!(**args) @action = args[:action] if args.key?(:action) + @canary_expire_time = args[:canary_expire_time] if args.key?(:canary_expire_time) @condition = args[:condition] if args.key?(:condition) @create_time = args[:create_time] if args.key?(:create_time) @evaluated_expressions = args[:evaluated_expressions] if args.key?(:evaluated_expressions) @@ -189,6 +201,7 @@ module Google @log_level = args[:log_level] if args.key?(:log_level) @log_message_format = args[:log_message_format] if args.key?(:log_message_format) @stack_frames = args[:stack_frames] if args.key?(:stack_frames) + @state = args[:state] if args.key?(:state) @status = args[:status] if args.key?(:status) @user_email = args[:user_email] if args.key?(:user_email) @variable_table = args[:variable_table] if args.key?(:variable_table) @@ -304,6 +317,11 @@ module Google # @return [String] attr_accessor :agent_version + # Used when setting breakpoint canary for this debuggee. + # Corresponds to the JSON property `canaryMode` + # @return [String] + attr_accessor :canary_mode + # Human readable description of the debuggee. # Including a human-readable project name, environment name and version # information is recommended. @@ -380,6 +398,7 @@ module Google # Update properties of this object def update!(**args) @agent_version = args[:agent_version] if args.key?(:agent_version) + @canary_mode = args[:canary_mode] if args.key?(:canary_mode) @description = args[:description] if args.key?(:description) @ext_source_contexts = args[:ext_source_contexts] if args.key?(:ext_source_contexts) @id = args[:id] if args.key?(:id) @@ -703,6 +722,12 @@ module Google class RegisterDebuggeeResponse include Google::Apis::Core::Hashable + # A unique ID generated for the agent. + # Each RegisterDebuggee request will generate a new agent ID. + # Corresponds to the JSON property `agentId` + # @return [String] + attr_accessor :agent_id + # Represents the debugged application. The application may include one or more # replicated processes executing the same code. Each of these processes is # attached with a debugger agent, carrying out the debugging commands. @@ -718,6 +743,7 @@ module Google # Update properties of this object def update!(**args) + @agent_id = args[:agent_id] if args.key?(:agent_id) @debuggee = args[:debuggee] if args.key?(:debuggee) end end diff --git a/generated/google/apis/clouddebugger_v2/representations.rb b/generated/google/apis/clouddebugger_v2/representations.rb index ef633fe6b..7c15ddb2f 100644 --- a/generated/google/apis/clouddebugger_v2/representations.rb +++ b/generated/google/apis/clouddebugger_v2/representations.rb @@ -196,6 +196,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :action, as: 'action' + property :canary_expire_time, as: 'canaryExpireTime' property :condition, as: 'condition' property :create_time, as: 'createTime' collection :evaluated_expressions, as: 'evaluatedExpressions', class: Google::Apis::ClouddebuggerV2::Variable, decorator: Google::Apis::ClouddebuggerV2::Variable::Representation @@ -211,6 +212,7 @@ module Google property :log_message_format, as: 'logMessageFormat' collection :stack_frames, as: 'stackFrames', class: Google::Apis::ClouddebuggerV2::StackFrame, decorator: Google::Apis::ClouddebuggerV2::StackFrame::Representation + property :state, as: 'state' property :status, as: 'status', class: Google::Apis::ClouddebuggerV2::StatusMessage, decorator: Google::Apis::ClouddebuggerV2::StatusMessage::Representation property :user_email, as: 'userEmail' @@ -253,6 +255,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :agent_version, as: 'agentVersion' + property :canary_mode, as: 'canaryMode' property :description, as: 'description' collection :ext_source_contexts, as: 'extSourceContexts', class: Google::Apis::ClouddebuggerV2::ExtendedSourceContext, decorator: Google::Apis::ClouddebuggerV2::ExtendedSourceContext::Representation @@ -366,6 +369,7 @@ module Google class RegisterDebuggeeResponse # @private class Representation < Google::Apis::Core::JsonRepresentation + property :agent_id, as: 'agentId' property :debuggee, as: 'debuggee', class: Google::Apis::ClouddebuggerV2::Debuggee, decorator: Google::Apis::ClouddebuggerV2::Debuggee::Representation end diff --git a/generated/google/apis/clouddebugger_v2/service.rb b/generated/google/apis/clouddebugger_v2/service.rb index 67ff67458..bcdd3d339 100644 --- a/generated/google/apis/clouddebugger_v2/service.rb +++ b/generated/google/apis/clouddebugger_v2/service.rb @@ -98,6 +98,9 @@ module Google # setting those breakpoints again. # @param [String] debuggee_id # Required. Identifies the debuggee. + # @param [String] agent_id + # Identifies the agent. + # This is the ID returned in the RegisterDebuggee response. # @param [Boolean] success_on_timeout # If set to `true` (recommended), returns `google.rpc.Code.OK` status and # sets the `wait_expired` response field to `true` when the server-selected @@ -126,11 +129,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_controller_debuggee_breakpoints(debuggee_id, success_on_timeout: nil, wait_token: nil, fields: nil, quota_user: nil, options: nil, &block) + def list_controller_debuggee_breakpoints(debuggee_id, agent_id: nil, success_on_timeout: nil, wait_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/controller/debuggees/{debuggeeId}/breakpoints', options) command.response_representation = Google::Apis::ClouddebuggerV2::ListActiveBreakpointsResponse::Representation command.response_class = Google::Apis::ClouddebuggerV2::ListActiveBreakpointsResponse command.params['debuggeeId'] = debuggee_id unless debuggee_id.nil? + command.query['agentId'] = agent_id unless agent_id.nil? command.query['successOnTimeout'] = success_on_timeout unless success_on_timeout.nil? command.query['waitToken'] = wait_token unless wait_token.nil? command.query['fields'] = fields unless fields.nil? @@ -352,6 +356,8 @@ module Google # @param [String] debuggee_id # Required. ID of the debuggee where the breakpoint is to be set. # @param [Google::Apis::ClouddebuggerV2::Breakpoint] breakpoint_object + # @param [String] canary_option + # The canary option set by the user upon setting breakpoint. # @param [String] client_version # Required. The client version making the call. # Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). @@ -372,13 +378,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def set_debugger_debuggee_breakpoint(debuggee_id, breakpoint_object = nil, client_version: nil, fields: nil, quota_user: nil, options: nil, &block) + def set_debugger_debuggee_breakpoint(debuggee_id, breakpoint_object = nil, canary_option: nil, client_version: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/debugger/debuggees/{debuggeeId}/breakpoints/set', options) command.request_representation = Google::Apis::ClouddebuggerV2::Breakpoint::Representation command.request_object = breakpoint_object command.response_representation = Google::Apis::ClouddebuggerV2::SetBreakpointResponse::Representation command.response_class = Google::Apis::ClouddebuggerV2::SetBreakpointResponse command.params['debuggeeId'] = debuggee_id unless debuggee_id.nil? + command.query['canaryOption'] = canary_option unless canary_option.nil? command.query['clientVersion'] = client_version unless client_version.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? diff --git a/generated/google/apis/cloudidentity_v1beta1.rb b/generated/google/apis/cloudidentity_v1beta1.rb index 6502a7c98..65eb20131 100644 --- a/generated/google/apis/cloudidentity_v1beta1.rb +++ b/generated/google/apis/cloudidentity_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/identity/ module CloudidentityV1beta1 VERSION = 'V1beta1' - REVISION = '20200401' + REVISION = '20200502' # See, change, create, and delete any of the Cloud Identity Groups that you can access, including the members of each group AUTH_CLOUD_IDENTITY_GROUPS = 'https://www.googleapis.com/auth/cloud-identity.groups' diff --git a/generated/google/apis/cloudidentity_v1beta1/classes.rb b/generated/google/apis/cloudidentity_v1beta1/classes.rb index b349057ca..f87db918b 100644 --- a/generated/google/apis/cloudidentity_v1beta1/classes.rb +++ b/generated/google/apis/cloudidentity_v1beta1/classes.rb @@ -26,63 +26,12 @@ module Google class AndroidAttributes include Google::Apis::Core::Hashable - # Baseband version of Android device. - # Corresponds to the JSON property `basebandVersion` - # @return [String] - attr_accessor :baseband_version - - # Device bootloader version. Example: 0.6.7. - # Corresponds to the JSON property `bootloaderVersion` - # @return [String] - attr_accessor :bootloader_version - - # Build number of Android device. - # Corresponds to the JSON property `buildNumber` - # @return [String] - attr_accessor :build_number - - # Whether developer options is enabled on device. - # Corresponds to the JSON property `enabledDeveloperOptions` - # @return [Boolean] - attr_accessor :enabled_developer_options - alias_method :enabled_developer_options?, :enabled_developer_options - # Whether applications from unknown sources can be installed on device. # Corresponds to the JSON property `enabledUnknownSources` # @return [Boolean] attr_accessor :enabled_unknown_sources alias_method :enabled_unknown_sources?, :enabled_unknown_sources - # Whether adb (USB debugging) is enabled on device. - # Corresponds to the JSON property `enabledUsbDebugging` - # @return [Boolean] - attr_accessor :enabled_usb_debugging - alias_method :enabled_usb_debugging?, :enabled_usb_debugging - - # Device encryption state. - # Corresponds to the JSON property `encryptionState` - # @return [String] - attr_accessor :encryption_state - - # Device hardware. Example: Sprout. - # Corresponds to the JSON property `hardware` - # @return [String] - attr_accessor :hardware - - # Kernel version of Android device. - # Corresponds to the JSON property `kernelVersion` - # @return [String] - attr_accessor :kernel_version - - # Domain name for Google accounts on device. Type for other accounts on - # device. Will only be populated if |ownership_privilege| is - # |PROFILE_OWNER| or |DEVICE_OWNER|. Does not include the account signed in - # to the device policy app if that account's domain has only one account. - # Examples: "com.example", "xyz.com". - # Corresponds to the JSON property `otherAccounts` - # @return [Array] - attr_accessor :other_accounts - # Whether this account is on an owner/primary profile. # For phones, only true for owner profiles. Android 4+ devices # can have secondary or restricted user profiles. @@ -96,11 +45,6 @@ module Google # @return [String] attr_accessor :ownership_privilege - # OS security patch update time on device. - # Corresponds to the JSON property `securityPatchTime` - # @return [String] - attr_accessor :security_patch_time - # Whether device supports Android work profiles. If false, this service # will not block access to corp data even if an administrator turns on the # "Enforce Work Profile" policy. @@ -115,19 +59,9 @@ module Google # Update properties of this object def update!(**args) - @baseband_version = args[:baseband_version] if args.key?(:baseband_version) - @bootloader_version = args[:bootloader_version] if args.key?(:bootloader_version) - @build_number = args[:build_number] if args.key?(:build_number) - @enabled_developer_options = args[:enabled_developer_options] if args.key?(:enabled_developer_options) @enabled_unknown_sources = args[:enabled_unknown_sources] if args.key?(:enabled_unknown_sources) - @enabled_usb_debugging = args[:enabled_usb_debugging] if args.key?(:enabled_usb_debugging) - @encryption_state = args[:encryption_state] if args.key?(:encryption_state) - @hardware = args[:hardware] if args.key?(:hardware) - @kernel_version = args[:kernel_version] if args.key?(:kernel_version) - @other_accounts = args[:other_accounts] if args.key?(:other_accounts) @owner_profile_account = args[:owner_profile_account] if args.key?(:owner_profile_account) @ownership_privilege = args[:ownership_privilege] if args.key?(:ownership_privilege) - @security_patch_time = args[:security_patch_time] if args.key?(:security_patch_time) @supports_work_profile = args[:supports_work_profile] if args.key?(:supports_work_profile) end end @@ -209,6 +143,132 @@ module Google end end + # Resource representing ClientState and supports updates from API users + class ClientState + include Google::Apis::Core::Hashable + + # The caller can specify asset tags for this resource + # Corresponds to the JSON property `assetTags` + # @return [Array] + attr_accessor :asset_tags + + # The compliance state of the resource as specified by the API client. + # Corresponds to the JSON property `complianceState` + # @return [String] + attr_accessor :compliance_state + + # Output only. The time the client state data was created. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # This field may be used to store a unique identifier for the API resource + # within which these CustomAttributes are a field. + # Corresponds to the JSON property `customId` + # @return [String] + attr_accessor :custom_id + + # The token that needs to be passed back for + # concurrency control in updates. Token needs to be passed back + # in UpdateRequest + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # The Health score of the resource + # Corresponds to the JSON property `healthScore` + # @return [String] + attr_accessor :health_score + + # The map of key-value attributes stored by callers specific to a + # device. The total serialized length of this map may not exceed 10KB. No + # limit is placed on the number of attributes in a map. + # Corresponds to the JSON property `keyValuePairs` + # @return [Hash] + attr_accessor :key_value_pairs + + # Output only. The time the client state data was last updated. + # Corresponds to the JSON property `lastUpdateTime` + # @return [String] + attr_accessor :last_update_time + + # The management state of the resource as specified by the API client. + # Corresponds to the JSON property `managed` + # @return [String] + attr_accessor :managed + + # Output only. [Resource name](https://cloud.google.com/apis/design/ + # resource_names) of + # the ClientState in format: + # `devices/`device_id`/deviceUsers/`device_user_id`/clientState/`partner_id``, + # where partner_id corresponds to the partner storing the data. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. The owner of the ClientState + # Corresponds to the JSON property `ownerType` + # @return [String] + attr_accessor :owner_type + + # A descriptive cause of the health score. + # Corresponds to the JSON property `scoreReason` + # @return [String] + attr_accessor :score_reason + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @asset_tags = args[:asset_tags] if args.key?(:asset_tags) + @compliance_state = args[:compliance_state] if args.key?(:compliance_state) + @create_time = args[:create_time] if args.key?(:create_time) + @custom_id = args[:custom_id] if args.key?(:custom_id) + @etag = args[:etag] if args.key?(:etag) + @health_score = args[:health_score] if args.key?(:health_score) + @key_value_pairs = args[:key_value_pairs] if args.key?(:key_value_pairs) + @last_update_time = args[:last_update_time] if args.key?(:last_update_time) + @managed = args[:managed] if args.key?(:managed) + @name = args[:name] if args.key?(:name) + @owner_type = args[:owner_type] if args.key?(:owner_type) + @score_reason = args[:score_reason] if args.key?(:score_reason) + end + end + + # Additional custom attribute values may be one of these types + class CustomAttributeValue + include Google::Apis::Core::Hashable + + # Represents a boolean value. + # Corresponds to the JSON property `boolValue` + # @return [Boolean] + attr_accessor :bool_value + alias_method :bool_value?, :bool_value + + # Represents a double value. + # Corresponds to the JSON property `numberValue` + # @return [Float] + attr_accessor :number_value + + # Represents a string value. + # Corresponds to the JSON property `stringValue` + # @return [String] + attr_accessor :string_value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bool_value = args[:bool_value] if args.key?(:bool_value) + @number_value = args[:number_value] if args.key?(:number_value) + @string_value = args[:string_value] if args.key?(:string_value) + end + end + # Represents a Device known to Google Cloud, independent of the device # ownership, type, and whether it is assigned or in use by a user. class Device @@ -224,11 +284,26 @@ module Google # @return [String] attr_accessor :asset_tag + # Output only. Baseband version of the device. + # Corresponds to the JSON property `basebandVersion` + # @return [String] + attr_accessor :baseband_version + + # Output only. Device bootloader version. Example: 0.6.7. + # Corresponds to the JSON property `bootloaderVersion` + # @return [String] + attr_accessor :bootloader_version + # Output only. Device brand. Example: Samsung. # Corresponds to the JSON property `brand` # @return [String] attr_accessor :brand + # Output only. Build number of the device. + # Corresponds to the JSON property `buildNumber` + # @return [String] + attr_accessor :build_number + # Output only. Represents whether the Device is compromised. # Corresponds to the JSON property `compromisedState` # @return [String] @@ -246,11 +321,33 @@ module Google # @return [String] attr_accessor :device_type + # Output only. Whether developer options is enabled on device. + # Corresponds to the JSON property `enabledDeveloperOptions` + # @return [Boolean] + attr_accessor :enabled_developer_options + alias_method :enabled_developer_options?, :enabled_developer_options + + # Output only. Whether USB debugging is enabled on device. + # Corresponds to the JSON property `enabledUsbDebugging` + # @return [Boolean] + attr_accessor :enabled_usb_debugging + alias_method :enabled_usb_debugging?, :enabled_usb_debugging + + # Output only. Device encryption state. + # Corresponds to the JSON property `encryptionState` + # @return [String] + attr_accessor :encryption_state + # Output only. IMEI number of device if GSM device; empty otherwise. # Corresponds to the JSON property `imei` # @return [String] attr_accessor :imei + # Output only. Kernel version of the device. + # Corresponds to the JSON property `kernelVersion` + # @return [String] + attr_accessor :kernel_version + # Most recent time when device synced with this service. # Corresponds to the JSON property `lastSyncTime` # @return [String] @@ -294,6 +391,16 @@ module Google # @return [String] attr_accessor :os_version + # Output only. Domain name for Google accounts on device. Type for other + # accounts on + # device. On Android, will only be populated if |ownership_privilege| is + # |PROFILE_OWNER| or |DEVICE_OWNER|. Does not include the account signed in + # to the device policy app if that account's domain has only one account. + # Examples: "com.example", "xyz.com". + # Corresponds to the JSON property `otherAccounts` + # @return [Array] + attr_accessor :other_accounts + # Whether the device is owned by the company or an individual # Corresponds to the JSON property `ownerType` # @return [String] @@ -304,6 +411,11 @@ module Google # @return [String] attr_accessor :release_version + # Output only. OS security patch update time on device. + # Corresponds to the JSON property `securityPatchTime` + # @return [String] + attr_accessor :security_patch_time + # Serial Number of device. Example: HT82V1A01076. # Corresponds to the JSON property `serialNumber` # @return [String] @@ -322,11 +434,18 @@ module Google def update!(**args) @android_specific_attributes = args[:android_specific_attributes] if args.key?(:android_specific_attributes) @asset_tag = args[:asset_tag] if args.key?(:asset_tag) + @baseband_version = args[:baseband_version] if args.key?(:baseband_version) + @bootloader_version = args[:bootloader_version] if args.key?(:bootloader_version) @brand = args[:brand] if args.key?(:brand) + @build_number = args[:build_number] if args.key?(:build_number) @compromised_state = args[:compromised_state] if args.key?(:compromised_state) @create_time = args[:create_time] if args.key?(:create_time) @device_type = args[:device_type] if args.key?(:device_type) + @enabled_developer_options = args[:enabled_developer_options] if args.key?(:enabled_developer_options) + @enabled_usb_debugging = args[:enabled_usb_debugging] if args.key?(:enabled_usb_debugging) + @encryption_state = args[:encryption_state] if args.key?(:encryption_state) @imei = args[:imei] if args.key?(:imei) + @kernel_version = args[:kernel_version] if args.key?(:kernel_version) @last_sync_time = args[:last_sync_time] if args.key?(:last_sync_time) @management_state = args[:management_state] if args.key?(:management_state) @manufacturer = args[:manufacturer] if args.key?(:manufacturer) @@ -335,8 +454,10 @@ module Google @name = args[:name] if args.key?(:name) @network_operator = args[:network_operator] if args.key?(:network_operator) @os_version = args[:os_version] if args.key?(:os_version) + @other_accounts = args[:other_accounts] if args.key?(:other_accounts) @owner_type = args[:owner_type] if args.key?(:owner_type) @release_version = args[:release_version] if args.key?(:release_version) + @security_patch_time = args[:security_patch_time] if args.key?(:security_patch_time) @serial_number = args[:serial_number] if args.key?(:serial_number) @wifi_mac_addresses = args[:wifi_mac_addresses] if args.key?(:wifi_mac_addresses) end @@ -614,6 +735,33 @@ module Google end end + # Response message that is returned in LRO result of ListClientStates + # Operation. + class ListClientStatesResponse + include Google::Apis::Core::Hashable + + # Client states meeting the list restrictions. + # Corresponds to the JSON property `clientStates` + # @return [Array] + attr_accessor :client_states + + # Token to retrieve the next page of results. Empty if there are no more + # results. + # 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) + @client_states = args[:client_states] if args.key?(:client_states) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + # Response message that is returned in LRO result of ListDeviceUsers Operation. class ListDeviceUsersResponse include Google::Apis::Core::Hashable diff --git a/generated/google/apis/cloudidentity_v1beta1/representations.rb b/generated/google/apis/cloudidentity_v1beta1/representations.rb index 7723eb424..3780c23c7 100644 --- a/generated/google/apis/cloudidentity_v1beta1/representations.rb +++ b/generated/google/apis/cloudidentity_v1beta1/representations.rb @@ -52,6 +52,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ClientState + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomAttributeValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Device class Representation < Google::Apis::Core::JsonRepresentation; end @@ -88,6 +100,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ListClientStatesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ListDeviceUsersResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -205,19 +223,9 @@ module Google class AndroidAttributes # @private class Representation < Google::Apis::Core::JsonRepresentation - property :baseband_version, as: 'basebandVersion' - property :bootloader_version, as: 'bootloaderVersion' - property :build_number, as: 'buildNumber' - property :enabled_developer_options, as: 'enabledDeveloperOptions' property :enabled_unknown_sources, as: 'enabledUnknownSources' - property :enabled_usb_debugging, as: 'enabledUsbDebugging' - property :encryption_state, as: 'encryptionState' - property :hardware, as: 'hardware' - property :kernel_version, as: 'kernelVersion' - collection :other_accounts, as: 'otherAccounts' property :owner_profile_account, as: 'ownerProfileAccount' property :ownership_privilege, as: 'ownershipPrivilege' - property :security_patch_time, as: 'securityPatchTime' property :supports_work_profile, as: 'supportsWorkProfile' end end @@ -254,17 +262,52 @@ module Google end end + class ClientState + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :asset_tags, as: 'assetTags' + property :compliance_state, as: 'complianceState' + property :create_time, as: 'createTime' + property :custom_id, as: 'customId' + property :etag, as: 'etag' + property :health_score, as: 'healthScore' + hash :key_value_pairs, as: 'keyValuePairs', class: Google::Apis::CloudidentityV1beta1::CustomAttributeValue, decorator: Google::Apis::CloudidentityV1beta1::CustomAttributeValue::Representation + + property :last_update_time, as: 'lastUpdateTime' + property :managed, as: 'managed' + property :name, as: 'name' + property :owner_type, as: 'ownerType' + property :score_reason, as: 'scoreReason' + end + end + + class CustomAttributeValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bool_value, as: 'boolValue' + property :number_value, as: 'numberValue' + property :string_value, as: 'stringValue' + end + end + class Device # @private class Representation < Google::Apis::Core::JsonRepresentation property :android_specific_attributes, as: 'androidSpecificAttributes', class: Google::Apis::CloudidentityV1beta1::AndroidAttributes, decorator: Google::Apis::CloudidentityV1beta1::AndroidAttributes::Representation property :asset_tag, as: 'assetTag' + property :baseband_version, as: 'basebandVersion' + property :bootloader_version, as: 'bootloaderVersion' property :brand, as: 'brand' + property :build_number, as: 'buildNumber' property :compromised_state, as: 'compromisedState' property :create_time, as: 'createTime' property :device_type, as: 'deviceType' + property :enabled_developer_options, as: 'enabledDeveloperOptions' + property :enabled_usb_debugging, as: 'enabledUsbDebugging' + property :encryption_state, as: 'encryptionState' property :imei, as: 'imei' + property :kernel_version, as: 'kernelVersion' property :last_sync_time, as: 'lastSyncTime' property :management_state, as: 'managementState' property :manufacturer, as: 'manufacturer' @@ -273,8 +316,10 @@ module Google property :name, as: 'name' property :network_operator, as: 'networkOperator' property :os_version, as: 'osVersion' + collection :other_accounts, as: 'otherAccounts' property :owner_type, as: 'ownerType' property :release_version, as: 'releaseVersion' + property :security_patch_time, as: 'securityPatchTime' property :serial_number, as: 'serialNumber' collection :wifi_mac_addresses, as: 'wifiMacAddresses' end @@ -342,6 +387,15 @@ module Google end end + class ListClientStatesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :client_states, as: 'clientStates', class: Google::Apis::CloudidentityV1beta1::ClientState, decorator: Google::Apis::CloudidentityV1beta1::ClientState::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + class ListDeviceUsersResponse # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/cloudiot_v1.rb b/generated/google/apis/cloudiot_v1.rb index 7407e8a81..1c51c11ab 100644 --- a/generated/google/apis/cloudiot_v1.rb +++ b/generated/google/apis/cloudiot_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/iot module CloudiotV1 VERSION = 'V1' - REVISION = '20200220' + REVISION = '20200414' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudresourcemanager_v1.rb b/generated/google/apis/cloudresourcemanager_v1.rb index 5757a9b4f..cfd87266c 100644 --- a/generated/google/apis/cloudresourcemanager_v1.rb +++ b/generated/google/apis/cloudresourcemanager_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/resource-manager module CloudresourcemanagerV1 VERSION = 'V1' - REVISION = '20200311' + REVISION = '20200415' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudresourcemanager_v1/classes.rb b/generated/google/apis/cloudresourcemanager_v1/classes.rb index 1829faf16..670a32a02 100644 --- a/generated/google/apis/cloudresourcemanager_v1/classes.rb +++ b/generated/google/apis/cloudresourcemanager_v1/classes.rb @@ -1773,8 +1773,7 @@ module Google # 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" - # This field is only used by Cloud IAM. + # `paths: "bindings, etag"` # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask diff --git a/generated/google/apis/cloudresourcemanager_v1beta1.rb b/generated/google/apis/cloudresourcemanager_v1beta1.rb index 498ae9e90..c59f50e62 100644 --- a/generated/google/apis/cloudresourcemanager_v1beta1.rb +++ b/generated/google/apis/cloudresourcemanager_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/resource-manager module CloudresourcemanagerV1beta1 VERSION = 'V1beta1' - REVISION = '20200203' + REVISION = '20200415' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb b/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb index 3163ff9da..74872711f 100644 --- a/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +++ b/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb @@ -949,8 +949,7 @@ module Google # 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" - # This field is only used by Cloud IAM. + # `paths: "bindings, etag"` # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask diff --git a/generated/google/apis/cloudresourcemanager_v2.rb b/generated/google/apis/cloudresourcemanager_v2.rb index af046d8f4..98d2840a7 100644 --- a/generated/google/apis/cloudresourcemanager_v2.rb +++ b/generated/google/apis/cloudresourcemanager_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/resource-manager module CloudresourcemanagerV2 VERSION = 'V2' - REVISION = '20200210' + REVISION = '20200415' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudresourcemanager_v2/classes.rb b/generated/google/apis/cloudresourcemanager_v2/classes.rb index f5d6edaad..296e4f4bc 100644 --- a/generated/google/apis/cloudresourcemanager_v2/classes.rb +++ b/generated/google/apis/cloudresourcemanager_v2/classes.rb @@ -854,8 +854,7 @@ module Google # 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" - # This field is only used by Cloud IAM. + # `paths: "bindings, etag"` # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask diff --git a/generated/google/apis/cloudresourcemanager_v2beta1.rb b/generated/google/apis/cloudresourcemanager_v2beta1.rb index 9d3efdf25..1be658187 100644 --- a/generated/google/apis/cloudresourcemanager_v2beta1.rb +++ b/generated/google/apis/cloudresourcemanager_v2beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/resource-manager module CloudresourcemanagerV2beta1 VERSION = 'V2beta1' - REVISION = '20200210' + REVISION = '20200415' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudresourcemanager_v2beta1/classes.rb b/generated/google/apis/cloudresourcemanager_v2beta1/classes.rb index 3d49cf544..4e6a9fe6b 100644 --- a/generated/google/apis/cloudresourcemanager_v2beta1/classes.rb +++ b/generated/google/apis/cloudresourcemanager_v2beta1/classes.rb @@ -854,8 +854,7 @@ module Google # 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" - # This field is only used by Cloud IAM. + # `paths: "bindings, etag"` # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask diff --git a/generated/google/apis/cloudscheduler_v1.rb b/generated/google/apis/cloudscheduler_v1.rb index b6a39bc9a..615d1cdd2 100644 --- a/generated/google/apis/cloudscheduler_v1.rb +++ b/generated/google/apis/cloudscheduler_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/scheduler/ module CloudschedulerV1 VERSION = 'V1' - REVISION = '20200210' + REVISION = '20200414' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudscheduler_v1/classes.rb b/generated/google/apis/cloudscheduler_v1/classes.rb index a2bad8921..77fa960dd 100644 --- a/generated/google/apis/cloudscheduler_v1/classes.rb +++ b/generated/google/apis/cloudscheduler_v1/classes.rb @@ -809,7 +809,7 @@ module Google # A job's retry interval starts at # min_backoff_duration, then doubles # `max_doublings` times, then increases linearly, and finally - # retries retries at intervals of + # retries at intervals of # max_backoff_duration up to # retry_count times. # For example, if min_backoff_duration is diff --git a/generated/google/apis/cloudscheduler_v1beta1.rb b/generated/google/apis/cloudscheduler_v1beta1.rb index 97d3c5f37..e0acc5725 100644 --- a/generated/google/apis/cloudscheduler_v1beta1.rb +++ b/generated/google/apis/cloudscheduler_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/scheduler/ module CloudschedulerV1beta1 VERSION = 'V1beta1' - REVISION = '20200210' + REVISION = '20200414' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudscheduler_v1beta1/classes.rb b/generated/google/apis/cloudscheduler_v1beta1/classes.rb index d2f40f505..11e51c4ec 100644 --- a/generated/google/apis/cloudscheduler_v1beta1/classes.rb +++ b/generated/google/apis/cloudscheduler_v1beta1/classes.rb @@ -810,7 +810,7 @@ module Google # A job's retry interval starts at # min_backoff_duration, then doubles # `max_doublings` times, then increases linearly, and finally - # retries retries at intervals of + # retries at intervals of # max_backoff_duration up to # retry_count times. # For example, if min_backoff_duration is diff --git a/generated/google/apis/cloudsearch_v1.rb b/generated/google/apis/cloudsearch_v1.rb index 3184cd548..b9372499e 100644 --- a/generated/google/apis/cloudsearch_v1.rb +++ b/generated/google/apis/cloudsearch_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/cloud-search/docs/guides/ module CloudsearchV1 VERSION = 'V1' - REVISION = '20200331' + REVISION = '20200421' # Index and serve your organization's data with Cloud Search AUTH_CLOUD_SEARCH = 'https://www.googleapis.com/auth/cloud_search' diff --git a/generated/google/apis/cloudsearch_v1/classes.rb b/generated/google/apis/cloudsearch_v1/classes.rb index e56b9cd4a..794964462 100644 --- a/generated/google/apis/cloudsearch_v1/classes.rb +++ b/generated/google/apis/cloudsearch_v1/classes.rb @@ -1707,7 +1707,7 @@ module Google include Google::Apis::Core::Hashable # Access control list information for the item. For more information see - # https://developers.google.com/cloud-search/docs/guides/index-your-data#acls + # [Map ACLs](/cloud-search/docs/guides/acls). # Corresponds to the JSON property `acl` # @return [Google::Apis::CloudsearchV1::ItemAcl] attr_accessor :acl @@ -1791,7 +1791,7 @@ module Google end # Access control list information for the item. For more information see - # https://developers.google.com/cloud-search/docs/guides/index-your-data#acls + # [Map ACLs](/cloud-search/docs/guides/acls). class ItemAcl include Google::Apis::Core::Hashable @@ -3533,7 +3533,8 @@ module Google # @return [String] attr_accessor :language_code - # Id of the application created using SearchApplicationsService. + # The ID generated when you create a search application using the + # [admin console](https://support.google.com/a/answer/9043922). # Corresponds to the JSON property `searchApplicationId` # @return [String] attr_accessor :search_application_id @@ -3875,7 +3876,8 @@ module Google # @return [String] attr_accessor :name - # IDs of the Long Running Operations (LROs) currently running for this + # Output only. IDs of the Long Running Operations (LROs) currently running for + # this # schema. Output only field. # Corresponds to the JSON property `operationIds` # @return [Array] diff --git a/generated/google/apis/cloudsearch_v1/service.rb b/generated/google/apis/cloudsearch_v1/service.rb index 0eaabc312..6ff278165 100644 --- a/generated/google/apis/cloudsearch_v1/service.rb +++ b/generated/google/apis/cloudsearch_v1/service.rb @@ -759,6 +759,7 @@ module Google # @param [String] name # Name of the Item to start a resumable upload. # Format: datasources/`source_id`/items/`item_id`. + # The maximum length is 1536 bytes. # @param [Google::Apis::CloudsearchV1::StartUploadItemRequest] start_upload_item_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -982,7 +983,8 @@ module Google # The suggest API does not use this parameter. Instead, suggest autocompletes # only based on characters in the query. # @param [String] request_options_search_application_id - # Id of the application created using SearchApplicationsService. + # The ID generated when you create a search application using the + # [admin console](https://support.google.com/a/answer/9043922). # @param [String] request_options_time_zone # Current user's time zone id, such as "America/Los_Angeles" or # "Australia/Sydney". These IDs are defined by diff --git a/generated/google/apis/cloudshell_v1alpha1.rb b/generated/google/apis/cloudshell_v1alpha1.rb index dd7b0a1ea..e8a6dd4e2 100644 --- a/generated/google/apis/cloudshell_v1alpha1.rb +++ b/generated/google/apis/cloudshell_v1alpha1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/shell/docs/ module CloudshellV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200411' + REVISION = '20200504' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudshell_v1alpha1/classes.rb b/generated/google/apis/cloudshell_v1alpha1/classes.rb index e123e6b0e..54cadd309 100644 --- a/generated/google/apis/cloudshell_v1alpha1/classes.rb +++ b/generated/google/apis/cloudshell_v1alpha1/classes.rb @@ -331,6 +331,11 @@ module Google # @return [String] attr_accessor :access_token + # Public keys that should be added to the environment before it is started. + # Corresponds to the JSON property `publicKeys` + # @return [Array] + attr_accessor :public_keys + def initialize(**args) update!(**args) end @@ -338,6 +343,7 @@ module Google # Update properties of this object def update!(**args) @access_token = args[:access_token] if args.key?(:access_token) + @public_keys = args[:public_keys] if args.key?(:public_keys) end end diff --git a/generated/google/apis/cloudshell_v1alpha1/representations.rb b/generated/google/apis/cloudshell_v1alpha1/representations.rb index 28f414325..4e5a49652 100644 --- a/generated/google/apis/cloudshell_v1alpha1/representations.rb +++ b/generated/google/apis/cloudshell_v1alpha1/representations.rb @@ -156,6 +156,8 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :access_token, as: 'accessToken' + collection :public_keys, as: 'publicKeys', class: Google::Apis::CloudshellV1alpha1::PublicKey, decorator: Google::Apis::CloudshellV1alpha1::PublicKey::Representation + end end diff --git a/generated/google/apis/cloudtasks_v2.rb b/generated/google/apis/cloudtasks_v2.rb index 5c9021f1f..46b6e3dfc 100644 --- a/generated/google/apis/cloudtasks_v2.rb +++ b/generated/google/apis/cloudtasks_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/tasks/ module CloudtasksV2 VERSION = 'V2' - REVISION = '20200228' + REVISION = '20200414' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudtasks_v2/classes.rb b/generated/google/apis/cloudtasks_v2/classes.rb index 054640058..3185713eb 100644 --- a/generated/google/apis/cloudtasks_v2/classes.rb +++ b/generated/google/apis/cloudtasks_v2/classes.rb @@ -151,16 +151,13 @@ module Google # The HTTP method to use for the request. The default is POST. # The app's request handler for the task's target URL must be able to handle - # HTTP requests with this http_method, otherwise the task attempt will fail - # with error code 405 (Method Not Allowed). See - # [Writing a push task request + # HTTP requests with this http_method, otherwise the task attempt fails with + # error code 405 (Method Not Allowed). See [Writing a push task request # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating- # handlers#writing_a_push_task_request_handler) - # and the documentation for the request handlers in the language your app is - # written in e.g. - # [Python Request - # Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/ - # requesthandlerclass). + # and the App Engine documentation for your runtime on [How Requests are + # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests- + # are-handled). # Corresponds to the JSON property `httpMethod` # @return [String] attr_accessor :http_method @@ -1276,7 +1273,7 @@ module Google # A task's retry interval starts at # min_backoff, then doubles # `max_doublings` times, then increases linearly, and finally - # retries retries at intervals of + # retries at intervals of # max_backoff up to # max_attempts times. # For example, if min_backoff is 10s, diff --git a/generated/google/apis/cloudtasks_v2beta2.rb b/generated/google/apis/cloudtasks_v2beta2.rb index f90b22341..e0bb49273 100644 --- a/generated/google/apis/cloudtasks_v2beta2.rb +++ b/generated/google/apis/cloudtasks_v2beta2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/tasks/ module CloudtasksV2beta2 VERSION = 'V2beta2' - REVISION = '20200324' + REVISION = '20200414' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudtasks_v2beta2/classes.rb b/generated/google/apis/cloudtasks_v2beta2/classes.rb index ff03f4b6a..11960f13a 100644 --- a/generated/google/apis/cloudtasks_v2beta2/classes.rb +++ b/generated/google/apis/cloudtasks_v2beta2/classes.rb @@ -164,16 +164,13 @@ module Google # The HTTP method to use for the request. The default is POST. # The app's request handler for the task's target URL must be able to handle - # HTTP requests with this http_method, otherwise the task attempt will fail - # with error code 405 (Method Not Allowed). See - # [Writing a push task request + # HTTP requests with this http_method, otherwise the task attempt fails with + # error code 405 (Method Not Allowed). See [Writing a push task request # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating- # handlers#writing_a_push_task_request_handler) - # and the documentation for the request handlers in the language your app is - # written in e.g. - # [Python Request - # Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/ - # requesthandlerclass). + # and the App Engine documentation for your runtime on [How Requests are + # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests- + # are-handled). # Corresponds to the JSON property `httpMethod` # @return [String] attr_accessor :http_method @@ -1434,7 +1431,7 @@ module Google # A task's retry interval starts at # min_backoff, then doubles # `max_doublings` times, then increases linearly, and finally - # retries retries at intervals of + # retries at intervals of # max_backoff up to # max_attempts times. # For example, if min_backoff is 10s, diff --git a/generated/google/apis/cloudtasks_v2beta3.rb b/generated/google/apis/cloudtasks_v2beta3.rb index 47a4b071f..110f8af07 100644 --- a/generated/google/apis/cloudtasks_v2beta3.rb +++ b/generated/google/apis/cloudtasks_v2beta3.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/tasks/ module CloudtasksV2beta3 VERSION = 'V2beta3' - REVISION = '20200210' + REVISION = '20200414' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudtasks_v2beta3/classes.rb b/generated/google/apis/cloudtasks_v2beta3/classes.rb index bf55d5f1c..ac3210184 100644 --- a/generated/google/apis/cloudtasks_v2beta3/classes.rb +++ b/generated/google/apis/cloudtasks_v2beta3/classes.rb @@ -190,16 +190,13 @@ module Google # The HTTP method to use for the request. The default is POST. # The app's request handler for the task's target URL must be able to handle - # HTTP requests with this http_method, otherwise the task attempt will fail - # with error code 405 (Method Not Allowed). See - # [Writing a push task request + # HTTP requests with this http_method, otherwise the task attempt fails with + # error code 405 (Method Not Allowed). See [Writing a push task request # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating- # handlers#writing_a_push_task_request_handler) - # and the documentation for the request handlers in the language your app is - # written in e.g. - # [Python Request - # Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/ - # requesthandlerclass). + # and the App Engine documentation for your runtime on [How Requests are + # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests- + # are-handled). # Corresponds to the JSON property `httpMethod` # @return [String] attr_accessor :http_method @@ -1299,7 +1296,7 @@ module Google # A task's retry interval starts at # min_backoff, then doubles # `max_doublings` times, then increases linearly, and finally - # retries retries at intervals of + # retries at intervals of # max_backoff up to # max_attempts times. # For example, if min_backoff is 10s, diff --git a/generated/google/apis/cloudtrace_v2.rb b/generated/google/apis/cloudtrace_v2.rb index 49cacf882..8921bd56b 100644 --- a/generated/google/apis/cloudtrace_v2.rb +++ b/generated/google/apis/cloudtrace_v2.rb @@ -29,7 +29,7 @@ module Google # @see https://cloud.google.com/trace module CloudtraceV2 VERSION = 'V2' - REVISION = '20200309' + REVISION = '20200414' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudtrace_v2/classes.rb b/generated/google/apis/cloudtrace_v2/classes.rb index d6b933960..4d448bef2 100644 --- a/generated/google/apis/cloudtrace_v2/classes.rb +++ b/generated/google/apis/cloudtrace_v2/classes.rb @@ -86,10 +86,9 @@ module Google # The set of attributes. Each attribute's key can be up to 128 bytes # long. The value can be a string up to 256 bytes, a signed 64-bit integer, # or the Boolean values `true` and `false`. For example: - # "/instance_id": "my-instance" - # "/http/user_agent": "" - # "/http/request_bytes": 300 - # "abc.com/myattribute": true + # "/instance_id": ` "string_value": ` "value": "my-instance" ` ` + # "/http/request_bytes": ` "int_value": 300 ` + # "abc.com/myattribute": ` "bool_value": false ` # Corresponds to the JSON property `attributeMap` # @return [Hash] attr_accessor :attribute_map diff --git a/generated/google/apis/commentanalyzer_v1alpha1.rb b/generated/google/apis/commentanalyzer_v1alpha1.rb deleted file mode 100644 index 8b49a9fff..000000000 --- a/generated/google/apis/commentanalyzer_v1alpha1.rb +++ /dev/null @@ -1,39 +0,0 @@ -# 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 'google/apis/commentanalyzer_v1alpha1/service.rb' -require 'google/apis/commentanalyzer_v1alpha1/classes.rb' -require 'google/apis/commentanalyzer_v1alpha1/representations.rb' - -module Google - module Apis - # Perspective Comment Analyzer API - # - # The Perspective Comment Analyzer API provides information about the potential - # impact of a comment on a conversation (e.g. it can provide a score for the " - # toxicity" of a comment). Users can leverage the "SuggestCommentScore" method - # to submit corrections to improve Perspective over time. Users can set the " - # doNotStore" flag to ensure that all submitted comments are automatically - # deleted after scores are returned. - # - # @see https://github.com/conversationai/perspectiveapi/blob/master/README.md - module CommentanalyzerV1alpha1 - VERSION = 'V1alpha1' - REVISION = '20200301' - - # View your email address - AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email' - end - end -end diff --git a/generated/google/apis/commentanalyzer_v1alpha1/classes.rb b/generated/google/apis/commentanalyzer_v1alpha1/classes.rb deleted file mode 100644 index f6a959ea8..000000000 --- a/generated/google/apis/commentanalyzer_v1alpha1/classes.rb +++ /dev/null @@ -1,480 +0,0 @@ -# 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 CommentanalyzerV1alpha1 - - # The comment analysis request message. - # LINT.IfChange - class AnalyzeCommentRequest - include Google::Apis::Core::Hashable - - # Opaque token that is echoed from the request to the response. - # Corresponds to the JSON property `clientToken` - # @return [String] - attr_accessor :client_token - - # Represents a body of text. - # Corresponds to the JSON property `comment` - # @return [Google::Apis::CommentanalyzerV1alpha1::TextEntry] - attr_accessor :comment - - # Optional identifier associating this AnalyzeCommentRequest with a - # particular client's community. Different communities may have different - # norms and rules. Specifying this value enables us to explore building - # community-specific models for clients. - # Corresponds to the JSON property `communityId` - # @return [String] - attr_accessor :community_id - - # Context is typically something that a Comment is referencing or replying to - # (such as an article, or previous comment). - # Note: Populate only ONE OF the following fields. The oneof syntax cannot be - # used because that would require nesting entries inside another message and - # breaking backwards compatibility. The server will return an error if more - # than one of the following fields is present. - # Corresponds to the JSON property `context` - # @return [Google::Apis::CommentanalyzerV1alpha1::Context] - attr_accessor :context - - # Do not store the comment or context sent in this request. By default, the - # service may store comments/context for debugging purposes. - # Corresponds to the JSON property `doNotStore` - # @return [Boolean] - attr_accessor :do_not_store - alias_method :do_not_store?, :do_not_store - - # The language(s) of the comment and context. If none are specified, we - # attempt to automatically detect the language. Specifying multiple languages - # means the text contains multiple lanugages. Both ISO and BCP-47 language - # codes are accepted. - # The server returns an error if no language was specified and language - # detection fails. The server also returns an error if the languages (either - # specified by the caller, or auto-detected) are not *all* supported by the - # service. - # Corresponds to the JSON property `languages` - # @return [Array] - attr_accessor :languages - - # Specification of requested attributes. The AttributeParameters serve as - # configuration for each associated attribute. The map keys are attribute - # names. The available attributes may be different on each RFE installation, - # and can be seen by calling ListAttributes (see above). - # For the prod installation, known as Perspective API, at - # blade:commentanalyzer-esf and commentanalyzer.googleapis.com, see - # go/checker-models (internal) and - # https://github.com/conversationai/perspectiveapi/blob/master/2-api/models.md# - # all-attribute-types. - # Corresponds to the JSON property `requestedAttributes` - # @return [Hash] - attr_accessor :requested_attributes - - # Session ID. Used to join related RPCs into a single session. For example, - # an interactive tool that calls both the AnalyzeComment and - # SuggestCommentScore RPCs should set all invocations of both RPCs to the - # same Session ID, typically a random 64-bit integer. - # Corresponds to the JSON property `sessionId` - # @return [String] - attr_accessor :session_id - - # An advisory parameter that will return span annotations if the model - # is capable of providing scores with sub-comment resolution. This will - # likely increase the size of the returned message. - # Corresponds to the JSON property `spanAnnotations` - # @return [Boolean] - attr_accessor :span_annotations - alias_method :span_annotations?, :span_annotations - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @client_token = args[:client_token] if args.key?(:client_token) - @comment = args[:comment] if args.key?(:comment) - @community_id = args[:community_id] if args.key?(:community_id) - @context = args[:context] if args.key?(:context) - @do_not_store = args[:do_not_store] if args.key?(:do_not_store) - @languages = args[:languages] if args.key?(:languages) - @requested_attributes = args[:requested_attributes] if args.key?(:requested_attributes) - @session_id = args[:session_id] if args.key?(:session_id) - @span_annotations = args[:span_annotations] if args.key?(:span_annotations) - end - end - - # The comment analysis response message. - class AnalyzeCommentResponse - include Google::Apis::Core::Hashable - - # Scores for the requested attributes. The map keys are attribute names (same - # as the requested_attribute field in AnalyzeCommentRequest, for example - # "ATTACK_ON_AUTHOR", "INFLAMMATORY", etc). - # Corresponds to the JSON property `attributeScores` - # @return [Hash] - attr_accessor :attribute_scores - - # Same token from the original AnalyzeCommentRequest. - # Corresponds to the JSON property `clientToken` - # @return [String] - attr_accessor :client_token - - # Contains the languages detected from the text content, sorted in order of - # likelihood. - # Corresponds to the JSON property `detectedLanguages` - # @return [Array] - attr_accessor :detected_languages - - # The language(s) used by CommentAnalyzer service to choose which Model to - # use when analyzing the comment. Might better be called - # "effective_languages". The logic used to make the choice is as follows: - # if !Request.languages.empty() - # effective_languages = Request.languages - # else - # effective_languages = detected_languages[0] - # Corresponds to the JSON property `languages` - # @return [Array] - attr_accessor :languages - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @attribute_scores = args[:attribute_scores] if args.key?(:attribute_scores) - @client_token = args[:client_token] if args.key?(:client_token) - @detected_languages = args[:detected_languages] if args.key?(:detected_languages) - @languages = args[:languages] if args.key?(:languages) - end - end - - # A type of context specific to a comment left on a single-threaded comment - # message board, where comments are either a top level comment or the child of - # a top level comment. - class ArticleAndParentComment - include Google::Apis::Core::Hashable - - # Represents a body of text. - # Corresponds to the JSON property `article` - # @return [Google::Apis::CommentanalyzerV1alpha1::TextEntry] - attr_accessor :article - - # Represents a body of text. - # Corresponds to the JSON property `parentComment` - # @return [Google::Apis::CommentanalyzerV1alpha1::TextEntry] - attr_accessor :parent_comment - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @article = args[:article] if args.key?(:article) - @parent_comment = args[:parent_comment] if args.key?(:parent_comment) - end - end - - # Configurable parameters for attribute scoring. - class AttributeParameters - include Google::Apis::Core::Hashable - - # Don't return scores for this attribute that are below this threshold. If - # unset, a default threshold will be applied. A FloatValue wrapper is used to - # distinguish between 0 vs. default/unset. - # Corresponds to the JSON property `scoreThreshold` - # @return [Float] - attr_accessor :score_threshold - - # What type of scores to return. If unset, defaults to probability scores. - # Corresponds to the JSON property `scoreType` - # @return [String] - attr_accessor :score_type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @score_threshold = args[:score_threshold] if args.key?(:score_threshold) - @score_type = args[:score_type] if args.key?(:score_type) - end - end - - # This holds score values for a single attribute. It contains both per-span - # scores as well as an overall summary score.. - class AttributeScores - include Google::Apis::Core::Hashable - - # Per-span scores. - # Corresponds to the JSON property `spanScores` - # @return [Array] - attr_accessor :span_scores - - # Analysis scores are described by a value and a ScoreType. - # Corresponds to the JSON property `summaryScore` - # @return [Google::Apis::CommentanalyzerV1alpha1::Score] - attr_accessor :summary_score - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @span_scores = args[:span_scores] if args.key?(:span_scores) - @summary_score = args[:summary_score] if args.key?(:summary_score) - end - end - - # Context is typically something that a Comment is referencing or replying to - # (such as an article, or previous comment). - # Note: Populate only ONE OF the following fields. The oneof syntax cannot be - # used because that would require nesting entries inside another message and - # breaking backwards compatibility. The server will return an error if more - # than one of the following fields is present. - class Context - include Google::Apis::Core::Hashable - - # A type of context specific to a comment left on a single-threaded comment - # message board, where comments are either a top level comment or the child of - # a top level comment. - # Corresponds to the JSON property `articleAndParentComment` - # @return [Google::Apis::CommentanalyzerV1alpha1::ArticleAndParentComment] - attr_accessor :article_and_parent_comment - - # A list of messages. For example, a linear comments section or forum thread. - # Corresponds to the JSON property `entries` - # @return [Array] - attr_accessor :entries - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @article_and_parent_comment = args[:article_and_parent_comment] if args.key?(:article_and_parent_comment) - @entries = args[:entries] if args.key?(:entries) - end - end - - # Analysis scores are described by a value and a ScoreType. - class Score - include Google::Apis::Core::Hashable - - # The type of the above value. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - # Score value. Semantics described by type below. - # Corresponds to the JSON property `value` - # @return [Float] - attr_accessor :value - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @type = args[:type] if args.key?(:type) - @value = args[:value] if args.key?(:value) - end - end - - # This is a single score for a given span of text. - class SpanScore - include Google::Apis::Core::Hashable - - # "begin" and "end" describe the span of the original text that the attribute - # score applies to. The values are the UTF-16 codepoint range. "end" is - # exclusive. For example, with the text "Hi there", the begin/end pair (0,2) - # describes the text "Hi". - # If "begin" and "end" are unset, the score applies to the full text. - # Corresponds to the JSON property `begin` - # @return [Fixnum] - attr_accessor :begin - - # - # Corresponds to the JSON property `end` - # @return [Fixnum] - attr_accessor :end - - # Analysis scores are described by a value and a ScoreType. - # Corresponds to the JSON property `score` - # @return [Google::Apis::CommentanalyzerV1alpha1::Score] - attr_accessor :score - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @begin = args[:begin] if args.key?(:begin) - @end = args[:end] if args.key?(:end) - @score = args[:score] if args.key?(:score) - end - end - - # The comment score suggestion request message. - class SuggestCommentScoreRequest - include Google::Apis::Core::Hashable - - # Attribute scores for the comment. The map keys are attribute names, same as - # the requested_attribute field in AnalyzeCommentRequest (for example - # "ATTACK_ON_AUTHOR", "INFLAMMATORY", etc.). This field has the same type as - # the `attribute_scores` field in AnalyzeCommentResponse. - # To specify an overall attribute score for the entire comment as a whole, - # use the `summary_score` field of the mapped AttributeScores object. To - # specify scores on specific subparts of the comment, use the `span_scores` - # field. All SpanScore objects must have begin and end fields set. - # All Score objects must be explicitly set (for binary classification, use - # the score values 0 and 1). If Score objects don't include a ScoreType, - # `PROBABILITY` is assumed. - # `attribute_scores` must not be empty. The mapped AttributeScores objects - # also must not be empty. An `INVALID_ARGUMENT` error is returned for all - # malformed requests. - # Corresponds to the JSON property `attributeScores` - # @return [Hash] - attr_accessor :attribute_scores - - # Opaque token that is echoed from the request to the response. - # Corresponds to the JSON property `clientToken` - # @return [String] - attr_accessor :client_token - - # Represents a body of text. - # Corresponds to the JSON property `comment` - # @return [Google::Apis::CommentanalyzerV1alpha1::TextEntry] - attr_accessor :comment - - # Optional identifier associating this comment score suggestion with a - # particular sub-community. Different communities may have different norms - # and rules. Specifying this value enables training community-specific - # models. - # Corresponds to the JSON property `communityId` - # @return [String] - attr_accessor :community_id - - # Context is typically something that a Comment is referencing or replying to - # (such as an article, or previous comment). - # Note: Populate only ONE OF the following fields. The oneof syntax cannot be - # used because that would require nesting entries inside another message and - # breaking backwards compatibility. The server will return an error if more - # than one of the following fields is present. - # Corresponds to the JSON property `context` - # @return [Google::Apis::CommentanalyzerV1alpha1::Context] - attr_accessor :context - - # The language(s) of the comment and context. If none are specified, we - # attempt to automatically detect the language. Both ISO and BCP-47 language - # codes are accepted. - # Corresponds to the JSON property `languages` - # @return [Array] - attr_accessor :languages - - # Session ID. Used to join related RPCs into a single session. For example, - # an interactive tool that calls both the AnalyzeComment and - # SuggestCommentScore RPCs should set all invocations of both RPCs to the - # same Session ID, typically a random 64-bit integer. - # Corresponds to the JSON property `sessionId` - # @return [String] - attr_accessor :session_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @attribute_scores = args[:attribute_scores] if args.key?(:attribute_scores) - @client_token = args[:client_token] if args.key?(:client_token) - @comment = args[:comment] if args.key?(:comment) - @community_id = args[:community_id] if args.key?(:community_id) - @context = args[:context] if args.key?(:context) - @languages = args[:languages] if args.key?(:languages) - @session_id = args[:session_id] if args.key?(:session_id) - end - end - - # The comment score suggestion response message. - class SuggestCommentScoreResponse - include Google::Apis::Core::Hashable - - # Same token from the original SuggestCommentScoreRequest. - # Corresponds to the JSON property `clientToken` - # @return [String] - attr_accessor :client_token - - # The list of languages detected from the comment text. - # Corresponds to the JSON property `detectedLanguages` - # @return [Array] - attr_accessor :detected_languages - - # The list of languages provided in the request. - # Corresponds to the JSON property `requestedLanguages` - # @return [Array] - attr_accessor :requested_languages - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @client_token = args[:client_token] if args.key?(:client_token) - @detected_languages = args[:detected_languages] if args.key?(:detected_languages) - @requested_languages = args[:requested_languages] if args.key?(:requested_languages) - end - end - - # Represents a body of text. - class TextEntry - include Google::Apis::Core::Hashable - - # UTF-8 encoded text. - # Corresponds to the JSON property `text` - # @return [String] - attr_accessor :text - - # Type of the text field. - # 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) - @text = args[:text] if args.key?(:text) - @type = args[:type] if args.key?(:type) - end - end - end - end -end diff --git a/generated/google/apis/commentanalyzer_v1alpha1/representations.rb b/generated/google/apis/commentanalyzer_v1alpha1/representations.rb deleted file mode 100644 index d91d93d2f..000000000 --- a/generated/google/apis/commentanalyzer_v1alpha1/representations.rb +++ /dev/null @@ -1,210 +0,0 @@ -# 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 CommentanalyzerV1alpha1 - - class AnalyzeCommentRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AnalyzeCommentResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ArticleAndParentComment - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AttributeParameters - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AttributeScores - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Context - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Score - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SpanScore - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SuggestCommentScoreRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SuggestCommentScoreResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TextEntry - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AnalyzeCommentRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :client_token, as: 'clientToken' - property :comment, as: 'comment', class: Google::Apis::CommentanalyzerV1alpha1::TextEntry, decorator: Google::Apis::CommentanalyzerV1alpha1::TextEntry::Representation - - property :community_id, as: 'communityId' - property :context, as: 'context', class: Google::Apis::CommentanalyzerV1alpha1::Context, decorator: Google::Apis::CommentanalyzerV1alpha1::Context::Representation - - property :do_not_store, as: 'doNotStore' - collection :languages, as: 'languages' - hash :requested_attributes, as: 'requestedAttributes', class: Google::Apis::CommentanalyzerV1alpha1::AttributeParameters, decorator: Google::Apis::CommentanalyzerV1alpha1::AttributeParameters::Representation - - property :session_id, as: 'sessionId' - property :span_annotations, as: 'spanAnnotations' - end - end - - class AnalyzeCommentResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - hash :attribute_scores, as: 'attributeScores', class: Google::Apis::CommentanalyzerV1alpha1::AttributeScores, decorator: Google::Apis::CommentanalyzerV1alpha1::AttributeScores::Representation - - property :client_token, as: 'clientToken' - collection :detected_languages, as: 'detectedLanguages' - collection :languages, as: 'languages' - end - end - - class ArticleAndParentComment - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :article, as: 'article', class: Google::Apis::CommentanalyzerV1alpha1::TextEntry, decorator: Google::Apis::CommentanalyzerV1alpha1::TextEntry::Representation - - property :parent_comment, as: 'parentComment', class: Google::Apis::CommentanalyzerV1alpha1::TextEntry, decorator: Google::Apis::CommentanalyzerV1alpha1::TextEntry::Representation - - end - end - - class AttributeParameters - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :score_threshold, as: 'scoreThreshold' - property :score_type, as: 'scoreType' - end - end - - class AttributeScores - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :span_scores, as: 'spanScores', class: Google::Apis::CommentanalyzerV1alpha1::SpanScore, decorator: Google::Apis::CommentanalyzerV1alpha1::SpanScore::Representation - - property :summary_score, as: 'summaryScore', class: Google::Apis::CommentanalyzerV1alpha1::Score, decorator: Google::Apis::CommentanalyzerV1alpha1::Score::Representation - - end - end - - class Context - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :article_and_parent_comment, as: 'articleAndParentComment', class: Google::Apis::CommentanalyzerV1alpha1::ArticleAndParentComment, decorator: Google::Apis::CommentanalyzerV1alpha1::ArticleAndParentComment::Representation - - collection :entries, as: 'entries', class: Google::Apis::CommentanalyzerV1alpha1::TextEntry, decorator: Google::Apis::CommentanalyzerV1alpha1::TextEntry::Representation - - end - end - - class Score - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :type, as: 'type' - property :value, as: 'value' - end - end - - class SpanScore - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :begin, as: 'begin' - property :end, as: 'end' - property :score, as: 'score', class: Google::Apis::CommentanalyzerV1alpha1::Score, decorator: Google::Apis::CommentanalyzerV1alpha1::Score::Representation - - end - end - - class SuggestCommentScoreRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - hash :attribute_scores, as: 'attributeScores', class: Google::Apis::CommentanalyzerV1alpha1::AttributeScores, decorator: Google::Apis::CommentanalyzerV1alpha1::AttributeScores::Representation - - property :client_token, as: 'clientToken' - property :comment, as: 'comment', class: Google::Apis::CommentanalyzerV1alpha1::TextEntry, decorator: Google::Apis::CommentanalyzerV1alpha1::TextEntry::Representation - - property :community_id, as: 'communityId' - property :context, as: 'context', class: Google::Apis::CommentanalyzerV1alpha1::Context, decorator: Google::Apis::CommentanalyzerV1alpha1::Context::Representation - - collection :languages, as: 'languages' - property :session_id, as: 'sessionId' - end - end - - class SuggestCommentScoreResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :client_token, as: 'clientToken' - collection :detected_languages, as: 'detectedLanguages' - collection :requested_languages, as: 'requestedLanguages' - end - end - - class TextEntry - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :text, as: 'text' - property :type, as: 'type' - end - end - end - end -end diff --git a/generated/google/apis/commentanalyzer_v1alpha1/service.rb b/generated/google/apis/commentanalyzer_v1alpha1/service.rb deleted file mode 100644 index 42f7b8cf1..000000000 --- a/generated/google/apis/commentanalyzer_v1alpha1/service.rb +++ /dev/null @@ -1,124 +0,0 @@ -# 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 '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 CommentanalyzerV1alpha1 - # Perspective Comment Analyzer API - # - # The Perspective Comment Analyzer API provides information about the potential - # impact of a comment on a conversation (e.g. it can provide a score for the " - # toxicity" of a comment). Users can leverage the "SuggestCommentScore" method - # to submit corrections to improve Perspective over time. Users can set the " - # doNotStore" flag to ensure that all submitted comments are automatically - # deleted after scores are returned. - # - # @example - # require 'google/apis/commentanalyzer_v1alpha1' - # - # Commentanalyzer = Google::Apis::CommentanalyzerV1alpha1 # Alias the module - # service = Commentanalyzer::CommentAnalyzerService.new - # - # @see https://github.com/conversationai/perspectiveapi/blob/master/README.md - class CommentAnalyzerService < Google::Apis::Core::BaseService - # @return [String] - # API key. Your API key identifies your project and provides you with API access, - # quota, and reports. Required unless you provide an OAuth 2.0 token. - attr_accessor :key - - # @return [String] - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - attr_accessor :quota_user - - def initialize - super('https://commentanalyzer.googleapis.com/', '') - @batch_path = 'batch' - end - - # Analyzes the provided text and returns scores for requested attributes. - # @param [Google::Apis::CommentanalyzerV1alpha1::AnalyzeCommentRequest] analyze_comment_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CommentanalyzerV1alpha1::AnalyzeCommentResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CommentanalyzerV1alpha1::AnalyzeCommentResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def analyze_comment(analyze_comment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1alpha1/comments:analyze', options) - command.request_representation = Google::Apis::CommentanalyzerV1alpha1::AnalyzeCommentRequest::Representation - command.request_object = analyze_comment_request_object - command.response_representation = Google::Apis::CommentanalyzerV1alpha1::AnalyzeCommentResponse::Representation - command.response_class = Google::Apis::CommentanalyzerV1alpha1::AnalyzeCommentResponse - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Suggest comment scores as training data. - # @param [Google::Apis::CommentanalyzerV1alpha1::SuggestCommentScoreRequest] suggest_comment_score_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CommentanalyzerV1alpha1::SuggestCommentScoreResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CommentanalyzerV1alpha1::SuggestCommentScoreResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def suggestscore_comment(suggest_comment_score_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1alpha1/comments:suggestscore', options) - command.request_representation = Google::Apis::CommentanalyzerV1alpha1::SuggestCommentScoreRequest::Representation - command.request_object = suggest_comment_score_request_object - command.response_representation = Google::Apis::CommentanalyzerV1alpha1::SuggestCommentScoreResponse::Representation - command.response_class = Google::Apis::CommentanalyzerV1alpha1::SuggestCommentScoreResponse - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - protected - - def apply_command_defaults(command) - command.query['key'] = key unless key.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - end - end - end - end -end diff --git a/generated/google/apis/composer_v1beta1.rb b/generated/google/apis/composer_v1beta1.rb index 33148912b..da522b339 100644 --- a/generated/google/apis/composer_v1beta1.rb +++ b/generated/google/apis/composer_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/composer/ module ComposerV1beta1 VERSION = 'V1beta1' - REVISION = '20200313' + REVISION = '20200421' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/composer_v1beta1/classes.rb b/generated/google/apis/composer_v1beta1/classes.rb index 55fdf8801..c25ae7707 100644 --- a/generated/google/apis/composer_v1beta1/classes.rb +++ b/generated/google/apis/composer_v1beta1/classes.rb @@ -32,8 +32,7 @@ module Google attr_accessor :description # IP address or range, defined using CIDR notation, of requests that this - # rule applies to. You can use the wildcard character "*" to match all IPs - # equivalent to "0/0" and "::/0" together. + # rule applies to. # Examples: `192.168.1.1` or `192.168.0.0/16` or `2001:db8::/32` # or `2001:0db8:0000:0042:0000:8a2e:0370:7334`. #

IP range prefixes should be properly truncated. For example, diff --git a/generated/google/apis/compute_alpha.rb b/generated/google/apis/compute_alpha.rb index 59aa3af08..87b09fd27 100644 --- a/generated/google/apis/compute_alpha.rb +++ b/generated/google/apis/compute_alpha.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/compute/docs/reference/latest/ module ComputeAlpha VERSION = 'Alpha' - REVISION = '20200311' + REVISION = '20200331' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/compute_alpha/classes.rb b/generated/google/apis/compute_alpha/classes.rb index 0c87ea7a0..0c00833e0 100644 --- a/generated/google/apis/compute_alpha/classes.rb +++ b/generated/google/apis/compute_alpha/classes.rb @@ -622,9 +622,9 @@ module Google # @return [String] attr_accessor :label_fingerprint - # Labels to apply to this Address resource. These can be later modified by the - # setLabels method. Each label key/value must comply with RFC1035. Label values - # may be empty. + # Labels for this resource. These can only be added or modified by the setLabels + # method. Each label key/value pair must comply with RFC1035. Label values may + # be empty. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -1144,6 +1144,12 @@ module Google # @return [Array] attr_accessor :local_ssds + # An opaque location hint used to place the allocation close to other resources. + # This field is for use by internal tools that use the public API. + # Corresponds to the JSON property `locationHint` + # @return [String] + attr_accessor :location_hint + # Compute Engine Long Term Release. When specified, VMs that have this policy # become long term release (internal: stable fleet) VMs. # For all VM shapes, this should result in fewer disruptions due to software @@ -1175,6 +1181,7 @@ module Google def update!(**args) @guest_accelerators = args[:guest_accelerators] if args.key?(:guest_accelerators) @local_ssds = args[:local_ssds] if args.key?(:local_ssds) + @location_hint = args[:location_hint] if args.key?(:location_hint) @long_term_release = args[:long_term_release] if args.key?(:long_term_release) @machine_type = args[:machine_type] if args.key?(:machine_type) @min_cpu_platform = args[:min_cpu_platform] if args.key?(:min_cpu_platform) @@ -6998,9 +7005,9 @@ module Google # @return [String] attr_accessor :label_fingerprint - # Labels to apply to this ExternalVpnGateway resource. These can be later - # modified by the setLabels method. Each label key/value must comply with - # RFC1035. Label values may be empty. + # Labels for this resource. These can only be added or modified by the setLabels + # method. Each label key/value pair must comply with RFC1035. Label values may + # be empty. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -7823,7 +7830,7 @@ module Google # @return [String] attr_accessor :label_fingerprint - # Labels to apply to this resource. These can be later modified by the setLabels + # Labels for this resource. These can only be added or modified by the setLabels # method. Each label key/value pair must comply with RFC1035. Label values may # be empty. # Corresponds to the JSON property `labels` @@ -12310,7 +12317,10 @@ module Google # @return [Array] attr_accessor :named_ports - # The URL of the network to which all instances in the instance group belong. + # [Output Only] The URL of the network to which all instances in the instance + # group belong. If your instance has multiple network interfaces, then the + # network and subnetwork fields only refer to the network and subnet used by + # your primary interface (nic0). # Corresponds to the JSON property `network` # @return [String] attr_accessor :network @@ -12337,7 +12347,9 @@ module Google attr_accessor :size # [Output Only] The URL of the subnetwork to which all instances in the instance - # group belong. + # group belong. If your instance has multiple network interfaces, then the + # network and subnetwork fields only refer to the network and subnet used by + # your primary interface (nic0). # Corresponds to the JSON property `subnetwork` # @return [String] attr_accessor :subnetwork @@ -15592,9 +15604,9 @@ module Google # @return [String] attr_accessor :label_fingerprint - # Labels to apply to this Interconnect resource. These can be later modified by - # the setLabels method. Each label key/value must comply with RFC1035. Label - # values may be empty. + # Labels for this resource. These can only be added or modified by the setLabels + # method. Each label key/value pair must comply with RFC1035. Label values may + # be empty. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -15838,9 +15850,9 @@ module Google # @return [String] attr_accessor :label_fingerprint - # Labels to apply to this InterconnectAttachment resource. These can be later - # modified by the setLabels method. Each label key/value must comply with - # RFC1035. Label values may be empty. + # Labels for this resource. These can only be added or modified by the setLabels + # method. Each label key/value pair must comply with RFC1035. Label values may + # be empty. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -18312,6 +18324,12 @@ module Google class MachineType include Google::Apis::Core::Hashable + # [Output Only] A list of accelerator configurations assigned to this machine + # type. + # Corresponds to the JSON property `accelerators` + # @return [Array] + attr_accessor :accelerators + # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] @@ -18394,6 +18412,7 @@ module Google # Update properties of this object def update!(**args) + @accelerators = args[:accelerators] if args.key?(:accelerators) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @deprecated = args[:deprecated] if args.key?(:deprecated) @description = args[:description] if args.key?(:description) @@ -18409,6 +18428,31 @@ module Google @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id) @zone = args[:zone] if args.key?(:zone) end + + # + class Accelerator + include Google::Apis::Core::Hashable + + # Number of accelerator cards exposed to the guest. + # Corresponds to the JSON property `guestAcceleratorCount` + # @return [Fixnum] + attr_accessor :guest_accelerator_count + + # The accelerator type resource name, not a full URL, e.g. 'nvidia-tesla-k80'. + # Corresponds to the JSON property `guestAcceleratorType` + # @return [String] + attr_accessor :guest_accelerator_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @guest_accelerator_count = args[:guest_accelerator_count] if args.key?(:guest_accelerator_count) + @guest_accelerator_type = args[:guest_accelerator_type] if args.key?(:guest_accelerator_type) + end + end end # @@ -20811,6 +20855,13 @@ module Google # @return [String] attr_accessor :kind + # An opaque location hint used to place the Node close to other resources. This + # field is for use by internal tools that use the public API. The location hint + # here on the NodeGroup overrides any location_hint present in the NodeTemplate. + # Corresponds to the JSON property `locationHint` + # @return [String] + attr_accessor :location_hint + # Specifies how to handle instances when a node in the group undergoes # maintenance. # Corresponds to the JSON property `maintenancePolicy` @@ -20877,6 +20928,7 @@ module Google @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) + @location_hint = args[:location_hint] if args.key?(:location_hint) @maintenance_policy = args[:maintenance_policy] if args.key?(:maintenance_policy) @maintenance_window = args[:maintenance_window] if args.key?(:maintenance_window) @name = args[:name] if args.key?(:name) @@ -29784,6 +29836,12 @@ module Google # @return [Array] attr_accessor :drain_nat_ips + # + # Corresponds to the JSON property `enableEndpointIndependentMapping` + # @return [Boolean] + attr_accessor :enable_endpoint_independent_mapping + alias_method :enable_endpoint_independent_mapping?, :enable_endpoint_independent_mapping + # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. # Corresponds to the JSON property `icmpIdleTimeoutSec` # @return [Fixnum] @@ -29823,6 +29881,11 @@ module Google # @return [Array] attr_accessor :nat_ips + # A list of rules associated with this NAT. + # Corresponds to the JSON property `rules` + # @return [Array] + attr_accessor :rules + # Specify the Nat option, which can take one of the following values: # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are # allowed to Nat. @@ -29851,6 +29914,12 @@ module Google # @return [Fixnum] attr_accessor :tcp_established_idle_timeout_sec + # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults + # to 120s if not set. + # Corresponds to the JSON property `tcpTimeWaitTimeoutSec` + # @return [Fixnum] + attr_accessor :tcp_time_wait_timeout_sec + # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not # set. # Corresponds to the JSON property `tcpTransitoryIdleTimeoutSec` @@ -29869,15 +29938,18 @@ module Google # Update properties of this object def update!(**args) @drain_nat_ips = args[:drain_nat_ips] if args.key?(:drain_nat_ips) + @enable_endpoint_independent_mapping = args[:enable_endpoint_independent_mapping] if args.key?(:enable_endpoint_independent_mapping) @icmp_idle_timeout_sec = args[:icmp_idle_timeout_sec] if args.key?(:icmp_idle_timeout_sec) @log_config = args[:log_config] if args.key?(:log_config) @min_ports_per_vm = args[:min_ports_per_vm] if args.key?(:min_ports_per_vm) @name = args[:name] if args.key?(:name) @nat_ip_allocate_option = args[:nat_ip_allocate_option] if args.key?(:nat_ip_allocate_option) @nat_ips = args[:nat_ips] if args.key?(:nat_ips) + @rules = args[:rules] if args.key?(:rules) @source_subnetwork_ip_ranges_to_nat = args[:source_subnetwork_ip_ranges_to_nat] if args.key?(:source_subnetwork_ip_ranges_to_nat) @subnetworks = args[:subnetworks] if args.key?(:subnetworks) @tcp_established_idle_timeout_sec = args[:tcp_established_idle_timeout_sec] if args.key?(:tcp_established_idle_timeout_sec) + @tcp_time_wait_timeout_sec = args[:tcp_time_wait_timeout_sec] if args.key?(:tcp_time_wait_timeout_sec) @tcp_transitory_idle_timeout_sec = args[:tcp_transitory_idle_timeout_sec] if args.key?(:tcp_transitory_idle_timeout_sec) @udp_idle_timeout_sec = args[:udp_idle_timeout_sec] if args.key?(:udp_idle_timeout_sec) end @@ -29914,6 +29986,79 @@ module Google end end + # + class RouterNatRule + include Google::Apis::Core::Hashable + + # The action to be enforced for traffic that matches this rule. + # Corresponds to the JSON property `action` + # @return [Google::Apis::ComputeAlpha::RouterNatRuleAction] + attr_accessor :action + + # An optional description of this rule. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # CEL expression that specifies the match condition that egress traffic from a + # VM is evaluated against. If it evaluates to true, the corresponding ?action? + # is enforced. + # The following examples are valid match expressions: + # "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/ + # 16')" + # "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'" + # Corresponds to the JSON property `match` + # @return [String] + attr_accessor :match + + # An integer indicating the priority of a rule in the list. The priority must be + # a positive value between 0 and 65000. The priority must be unique among rules + # within a NAT. + # Corresponds to the JSON property `priority` + # @return [Fixnum] + attr_accessor :priority + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @action = args[:action] if args.key?(:action) + @description = args[:description] if args.key?(:description) + @match = args[:match] if args.key?(:match) + @priority = args[:priority] if args.key?(:priority) + end + end + + # + class RouterNatRuleAction + include Google::Apis::Core::Hashable + + # A list of URLs of the IP resources used for this NAT rule. These IP addresses + # must be valid static external IP addresses assigned to the project. + # Corresponds to the JSON property `sourceNatActiveIps` + # @return [Array] + attr_accessor :source_nat_active_ips + + # A list of URLs of the IP resources to be drained. These IPs must be valid + # static external IPs that have been assigned to the NAT. These IPs should be + # used for updating/patching a NAT rule only. + # Corresponds to the JSON property `sourceNatDrainIps` + # @return [Array] + attr_accessor :source_nat_drain_ips + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @source_nat_active_ips = args[:source_nat_active_ips] if args.key?(:source_nat_active_ips) + @source_nat_drain_ips = args[:source_nat_drain_ips] if args.key?(:source_nat_drain_ips) + end + end + # Defines the IP ranges that want to use NAT for a subnetwork. class RouterNatSubnetworkToNat include Google::Apis::Core::Hashable @@ -30802,9 +30947,9 @@ module Google # @return [String] attr_accessor :label_fingerprint - # Labels to apply to this security policy resource. These can be later modified - # by the setLabels method. Each label key/value must comply with RFC1035. Label - # values may be empty. + # Labels for this resource. These can only be added or modified by the setLabels + # method. Each label key/value pair must comply with RFC1035. Label values may + # be empty. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -31574,6 +31719,246 @@ module Google end end + # Represents a ServiceAttachment resource. + # A service attachment represents a service that a producer has exposed. It + # encapsulates the load balancer which fronts the service runs and a list of NAT + # IP ranges that the producers uses to represent the consumers connecting to the + # service. + class ServiceAttachment + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `connectionPreference` + # @return [String] + attr_accessor :connection_preference + + # An array of forwarding rules for all the consumers connected to this service + # attachment. + # Corresponds to the JSON property `consumerForwardingRules` + # @return [Array] + attr_accessor :consumer_forwarding_rules + + # [Output Only] Creation timestamp in RFC3339 text format. + # Corresponds to the JSON property `creationTimestamp` + # @return [String] + attr_accessor :creation_timestamp + + # An optional description of this resource. Provide this property when you + # create the resource. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # [Output Only] The unique identifier for the resource type. The server + # generates this identifier. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # [Output Only] Type of the resource. Always compute#serviceAttachment for + # service attachments. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of the resource. Provided by the client when the resource is created. The + # name must be 1-63 characters long, and comply with RFC1035. Specifically, the + # name must be 1-63 characters long and match the regular expression `[a-z]([-a- + # z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, + # and all following characters must be a dash, lowercase letter, or digit, + # except the last character, which cannot be a dash. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # An array of IP CIDR ranges where each range is the url of the address resource + # which represents the range provided by the service producer to use for NAT in + # this service attachment. + # Corresponds to the JSON property `natIpCidrRanges` + # @return [Array] + attr_accessor :nat_ip_cidr_ranges + + # The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is + # serving the endpoint identified by this service attachment. + # Corresponds to the JSON property `producerForwardingRule` + # @return [String] + attr_accessor :producer_forwarding_rule + + # [Output Only] URL of the region where the service attachment resides. This + # field applies only to the region resource. You must specify this field as part + # of the HTTP request URL. It is not settable as a field in the request body. + # Corresponds to the JSON property `region` + # @return [String] + attr_accessor :region + + # [Output Only] Server-defined URL for the resource. + # Corresponds to the JSON property `selfLink` + # @return [String] + attr_accessor :self_link + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @connection_preference = args[:connection_preference] if args.key?(:connection_preference) + @consumer_forwarding_rules = args[:consumer_forwarding_rules] if args.key?(:consumer_forwarding_rules) + @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) + @description = args[:description] if args.key?(:description) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @nat_ip_cidr_ranges = args[:nat_ip_cidr_ranges] if args.key?(:nat_ip_cidr_ranges) + @producer_forwarding_rule = args[:producer_forwarding_rule] if args.key?(:producer_forwarding_rule) + @region = args[:region] if args.key?(:region) + @self_link = args[:self_link] if args.key?(:self_link) + end + end + + # [Output Only] A consumer forwarding rule connected to this service attachment. + class ServiceAttachmentConsumerForwardingRule + include Google::Apis::Core::Hashable + + # The url of a consumer forwarding rule. + # Corresponds to the JSON property `forwardingRule` + # @return [String] + attr_accessor :forwarding_rule + + # The status of the forwarding rule. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @forwarding_rule = args[:forwarding_rule] if args.key?(:forwarding_rule) + @status = args[:status] if args.key?(:status) + end + end + + # + class ServiceAttachmentList + include Google::Apis::Core::Hashable + + # [Output Only] Unique identifier for the resource; defined by the server. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # A list of ServiceAttachment resources. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # [Output Only] Type of the resource. Always compute#serviceAttachment for + # service attachments. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # [Output Only] Server-defined URL for this resource. + # Corresponds to the JSON property `selfLink` + # @return [String] + attr_accessor :self_link + + # [Output Only] Informational warning message. + # Corresponds to the JSON property `warning` + # @return [Google::Apis::ComputeAlpha::ServiceAttachmentList::Warning] + attr_accessor :warning + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @items = args[:items] if args.key?(:items) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @self_link = args[:self_link] if args.key?(:self_link) + @warning = args[:warning] if args.key?(:warning) + end + + # [Output Only] Informational warning message. + class Warning + include Google::Apis::Core::Hashable + + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. + # Corresponds to the JSON property `code` + # @return [String] + attr_accessor :code + + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` + # Corresponds to the JSON property `data` + # @return [Array] + attr_accessor :data + + # [Output Only] A human-readable description of the warning code. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @data = args[:data] if args.key?(:data) + @message = args[:message] if args.key?(:message) + end + + # + class Datum + include Google::Apis::Core::Hashable + + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + + # [Output Only] A warning data value corresponding to the key. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @key = args[:key] if args.key?(:key) + @value = args[:value] if args.key?(:value) + end + end + end + end + # A set of Shielded Instance options. class ShieldedInstanceConfig include Google::Apis::Core::Hashable @@ -36817,9 +37202,9 @@ module Google # @return [String] attr_accessor :label_fingerprint - # Labels to apply to this TargetVpnGateway resource. These can be later modified - # by the setLabels method. Each label key/value must comply with RFC1035. Label - # values may be empty. + # Labels for this resource. These can only be added or modified by the setLabels + # method. Each label key/value pair must comply with RFC1035. Label values may + # be empty. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -38619,9 +39004,9 @@ module Google # @return [String] attr_accessor :label_fingerprint - # Labels to apply to this VpnGateway resource. These can be later modified by - # the setLabels method. Each label key/value must comply with RFC1035. Label - # values may be empty. + # Labels for this resource. These can only be added or modified by the setLabels + # method. Each label key/value pair must comply with RFC1035. Label values may + # be empty. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -38652,7 +39037,7 @@ module Google # @return [String] attr_accessor :self_link - # [Output Only] A list of interfaces on this VPN gateway. + # A list of interfaces on this VPN gateway. # Corresponds to the JSON property `vpnInterfaces` # @return [Array] attr_accessor :vpn_interfaces @@ -39050,7 +39435,7 @@ module Google # @return [Fixnum] attr_accessor :id - # The external IP address for this VPN gateway interface. + # [Output Only] The external IP address for this VPN gateway interface. # Corresponds to the JSON property `ipAddress` # @return [String] attr_accessor :ip_address @@ -39227,9 +39612,9 @@ module Google # @return [String] attr_accessor :label_fingerprint - # Labels to apply to this VpnTunnel. These can be later modified by the - # setLabels method. Each label key/value pair must comply with RFC1035. Label - # values may be empty. + # Labels for this resource. These can only be added or modified by the setLabels + # method. Each label key/value pair must comply with RFC1035. Label values may + # be empty. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels diff --git a/generated/google/apis/compute_alpha/representations.rb b/generated/google/apis/compute_alpha/representations.rb index 08b88810c..7a2a391ec 100644 --- a/generated/google/apis/compute_alpha/representations.rb +++ b/generated/google/apis/compute_alpha/representations.rb @@ -2268,6 +2268,12 @@ module Google class MachineType class Representation < Google::Apis::Core::JsonRepresentation; end + + class Accelerator + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end include Google::Apis::Core::JsonObjectSupport end @@ -3922,6 +3928,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class RouterNatRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RouterNatRuleAction + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class RouterNatSubnetworkToNat class Representation < Google::Apis::Core::JsonRepresentation; end @@ -4138,6 +4156,36 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ServiceAttachment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ServiceAttachmentConsumerForwardingRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ServiceAttachmentList + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Warning + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Datum + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + class ShieldedInstanceConfig class Representation < Google::Apis::Core::JsonRepresentation; end @@ -5643,6 +5691,7 @@ module Google collection :local_ssds, as: 'localSsds', class: Google::Apis::ComputeAlpha::AllocationSpecificSkuAllocationAllocatedInstancePropertiesReservedDisk, decorator: Google::Apis::ComputeAlpha::AllocationSpecificSkuAllocationAllocatedInstancePropertiesReservedDisk::Representation + property :location_hint, as: 'locationHint' property :long_term_release, as: 'longTermRelease' property :machine_type, as: 'machineType' property :min_cpu_platform, as: 'minCpuPlatform' @@ -9699,6 +9748,8 @@ module Google class MachineType # @private class Representation < Google::Apis::Core::JsonRepresentation + collection :accelerators, as: 'accelerators', class: Google::Apis::ComputeAlpha::MachineType::Accelerator, decorator: Google::Apis::ComputeAlpha::MachineType::Accelerator::Representation + property :creation_timestamp, as: 'creationTimestamp' property :deprecated, as: 'deprecated', class: Google::Apis::ComputeAlpha::DeprecationStatus, decorator: Google::Apis::ComputeAlpha::DeprecationStatus::Representation @@ -9715,6 +9766,14 @@ module Google property :self_link_with_id, as: 'selfLinkWithId' property :zone, as: 'zone' end + + class Accelerator + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :guest_accelerator_count, as: 'guestAcceleratorCount' + property :guest_accelerator_type, as: 'guestAcceleratorType' + end + end end class MachineTypeAggregatedList @@ -10329,6 +10388,7 @@ module Google property :fingerprint, :base64 => true, as: 'fingerprint' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' + property :location_hint, as: 'locationHint' property :maintenance_policy, as: 'maintenancePolicy' property :maintenance_window, as: 'maintenanceWindow', class: Google::Apis::ComputeAlpha::NodeGroupMaintenanceWindow, decorator: Google::Apis::ComputeAlpha::NodeGroupMaintenanceWindow::Representation @@ -12653,6 +12713,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation collection :drain_nat_ips, as: 'drainNatIps' + property :enable_endpoint_independent_mapping, as: 'enableEndpointIndependentMapping' property :icmp_idle_timeout_sec, as: 'icmpIdleTimeoutSec' property :log_config, as: 'logConfig', class: Google::Apis::ComputeAlpha::RouterNatLogConfig, decorator: Google::Apis::ComputeAlpha::RouterNatLogConfig::Representation @@ -12660,10 +12721,13 @@ module Google property :name, as: 'name' property :nat_ip_allocate_option, as: 'natIpAllocateOption' collection :nat_ips, as: 'natIps' + collection :rules, as: 'rules', class: Google::Apis::ComputeAlpha::RouterNatRule, decorator: Google::Apis::ComputeAlpha::RouterNatRule::Representation + property :source_subnetwork_ip_ranges_to_nat, as: 'sourceSubnetworkIpRangesToNat' collection :subnetworks, as: 'subnetworks', class: Google::Apis::ComputeAlpha::RouterNatSubnetworkToNat, decorator: Google::Apis::ComputeAlpha::RouterNatSubnetworkToNat::Representation property :tcp_established_idle_timeout_sec, as: 'tcpEstablishedIdleTimeoutSec' + property :tcp_time_wait_timeout_sec, as: 'tcpTimeWaitTimeoutSec' property :tcp_transitory_idle_timeout_sec, as: 'tcpTransitoryIdleTimeoutSec' property :udp_idle_timeout_sec, as: 'udpIdleTimeoutSec' end @@ -12677,6 +12741,25 @@ module Google end end + class RouterNatRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :action, as: 'action', class: Google::Apis::ComputeAlpha::RouterNatRuleAction, decorator: Google::Apis::ComputeAlpha::RouterNatRuleAction::Representation + + property :description, as: 'description' + property :match, as: 'match' + property :priority, as: 'priority' + end + end + + class RouterNatRuleAction + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :source_nat_active_ips, as: 'sourceNatActiveIps' + collection :source_nat_drain_ips, as: 'sourceNatDrainIps' + end + end + class RouterNatSubnetworkToNat # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -13087,6 +13170,64 @@ module Google end end + class ServiceAttachment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :connection_preference, as: 'connectionPreference' + collection :consumer_forwarding_rules, as: 'consumerForwardingRules', class: Google::Apis::ComputeAlpha::ServiceAttachmentConsumerForwardingRule, decorator: Google::Apis::ComputeAlpha::ServiceAttachmentConsumerForwardingRule::Representation + + property :creation_timestamp, as: 'creationTimestamp' + property :description, as: 'description' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + collection :nat_ip_cidr_ranges, as: 'natIpCidrRanges' + property :producer_forwarding_rule, as: 'producerForwardingRule' + property :region, as: 'region' + property :self_link, as: 'selfLink' + end + end + + class ServiceAttachmentConsumerForwardingRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :forwarding_rule, as: 'forwardingRule' + property :status, as: 'status' + end + end + + class ServiceAttachmentList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + collection :items, as: 'items', class: Google::Apis::ComputeAlpha::ServiceAttachment, decorator: Google::Apis::ComputeAlpha::ServiceAttachment::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + property :self_link, as: 'selfLink' + property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::ServiceAttachmentList::Warning, decorator: Google::Apis::ComputeAlpha::ServiceAttachmentList::Warning::Representation + + end + + class Warning + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :data, as: 'data', class: Google::Apis::ComputeAlpha::ServiceAttachmentList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::ServiceAttachmentList::Warning::Datum::Representation + + property :message, as: 'message' + end + + class Datum + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :key, as: 'key' + property :value, as: 'value' + end + end + end + end + class ShieldedInstanceConfig # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/compute_alpha/service.rb b/generated/google/apis/compute_alpha/service.rb index ad41ab57d..0336b0d62 100644 --- a/generated/google/apis/compute_alpha/service.rb +++ b/generated/google/apis/compute_alpha/service.rb @@ -1921,6 +1921,8 @@ module Google end # Gets the most recent health check results for this BackendService. + # Example request body: + # ` "group": "/zones/us-east1-b/instanceGroups/lb-backend-example" ` # @param [String] project # @param [String] backend_service # Name of the BackendService resource to which the queried instance belongs. @@ -16897,7 +16899,7 @@ module Google execute_or_queue_command(command, &block) end - # Patch the node group. + # Updates the specified node group. # @param [String] project # Project ID for this request. # @param [String] zone @@ -29354,6 +29356,354 @@ module Google execute_or_queue_command(command, &block) end + # Deletes the specified ServiceAttachment in the given scope + # @param [String] project + # Project ID for this request. + # @param [String] region + # Name of the region of this request. + # @param [String] service_attachment + # Name of the ServiceAttachment resource to delete. + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_service_attachment(project, region, service_attachment, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, '{project}/regions/{region}/serviceAttachments/{serviceAttachment}', options) + command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation + command.response_class = Google::Apis::ComputeAlpha::Operation + command.params['project'] = project unless project.nil? + command.params['region'] = region unless region.nil? + command.params['serviceAttachment'] = service_attachment unless service_attachment.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Returns the specified ServiceAttachment resource in the given scope. + # @param [String] project + # Project ID for this request. + # @param [String] region + # Name of the region of this request. + # @param [String] service_attachment + # Name of the ServiceAttachment resource to return. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::ServiceAttachment] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::ServiceAttachment] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_service_attachment(project, region, service_attachment, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/regions/{region}/serviceAttachments/{serviceAttachment}', options) + command.response_representation = Google::Apis::ComputeAlpha::ServiceAttachment::Representation + command.response_class = Google::Apis::ComputeAlpha::ServiceAttachment + command.params['project'] = project unless project.nil? + command.params['region'] = region unless region.nil? + command.params['serviceAttachment'] = service_attachment unless service_attachment.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets the access control policy for a resource. May be empty if no such policy + # or resource exists. + # @param [String] project + # Project ID for this request. + # @param [String] region + # The name of the region for this request. + # @param [String] resource + # Name or id of the resource for this request. + # @param [Fixnum] options_requested_policy_version + # Requested IAM Policy version. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_service_attachment_iam_policy(project, region, resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/regions/{region}/serviceAttachments/{resource}/getIamPolicy', options) + command.response_representation = Google::Apis::ComputeAlpha::Policy::Representation + command.response_class = Google::Apis::ComputeAlpha::Policy + command.params['project'] = project unless project.nil? + command.params['region'] = region unless region.nil? + command.params['resource'] = resource unless resource.nil? + command.query['optionsRequestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Creates a ServiceAttachment in the specified project in the given scope using + # the parameters that are included in the request. + # @param [String] project + # Project ID for this request. + # @param [String] region + # Name of the region of this request. + # @param [Google::Apis::ComputeAlpha::ServiceAttachment] service_attachment_object + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_service_attachment(project, region, service_attachment_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/regions/{region}/serviceAttachments', options) + command.request_representation = Google::Apis::ComputeAlpha::ServiceAttachment::Representation + command.request_object = service_attachment_object + command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation + command.response_class = Google::Apis::ComputeAlpha::Operation + command.params['project'] = project unless project.nil? + command.params['region'] = region unless region.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Lists the ServiceAttachments for a project in the given scope. + # @param [String] project + # Project ID for this request. + # @param [String] region + # Name of the region of this request. + # @param [String] filter + # A filter expression that filters resources listed in the response. The + # expression must specify the field name, a comparison operator, and the value + # that you want to use for filtering. The value must be a string, a number, or a + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. + # For example, if you are filtering Compute Engine instances, you can exclude + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled + # for automatic restarts. You can use filtering on nested fields to filter based + # on resource labels. + # To filter on multiple expressions, provide each separate expression within + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Fixnum] max_results + # The maximum number of results per page that should be returned. If the number + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + # @param [String] order_by + # Sorts list results by a certain order. By default, results are returned in + # alphanumerical order based on the resource name. + # You can also sort results in descending order based on the creation timestamp + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). + # Use this to sort resources like operations so that the newest operation is + # returned first. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. + # @param [String] page_token + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::ServiceAttachmentList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::ServiceAttachmentList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_service_attachments(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/regions/{region}/serviceAttachments', options) + command.response_representation = Google::Apis::ComputeAlpha::ServiceAttachmentList::Representation + command.response_class = Google::Apis::ComputeAlpha::ServiceAttachmentList + command.params['project'] = project unless project.nil? + command.params['region'] = region unless region.nil? + command.query['filter'] = filter unless filter.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Sets the access control policy on the specified resource. Replaces any + # existing policy. + # @param [String] project + # Project ID for this request. + # @param [String] region + # The name of the region for this request. + # @param [String] resource + # Name or id of the resource for this request. + # @param [Google::Apis::ComputeAlpha::RegionSetPolicyRequest] region_set_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_service_attachment_iam_policy(project, region, resource, region_set_policy_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/regions/{region}/serviceAttachments/{resource}/setIamPolicy', options) + command.request_representation = Google::Apis::ComputeAlpha::RegionSetPolicyRequest::Representation + command.request_object = region_set_policy_request_object + command.response_representation = Google::Apis::ComputeAlpha::Policy::Representation + command.response_class = Google::Apis::ComputeAlpha::Policy + command.params['project'] = project unless project.nil? + command.params['region'] = region unless region.nil? + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Returns permissions that a caller has on the specified resource. + # @param [String] project + # Project ID for this request. + # @param [String] region + # The name of the region for this request. + # @param [String] resource + # Name or id of the resource for this request. + # @param [Google::Apis::ComputeAlpha::TestPermissionsRequest] test_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::TestPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::TestPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_service_attachment_iam_permissions(project, region, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/regions/{region}/serviceAttachments/{resource}/testIamPermissions', options) + command.request_representation = Google::Apis::ComputeAlpha::TestPermissionsRequest::Representation + command.request_object = test_permissions_request_object + command.response_representation = Google::Apis::ComputeAlpha::TestPermissionsResponse::Representation + command.response_class = Google::Apis::ComputeAlpha::TestPermissionsResponse + command.params['project'] = project unless project.nil? + command.params['region'] = region unless region.nil? + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Deletes the specified Snapshot resource. Keep in mind that deleting a single # snapshot might not necessarily delete all the data on that snapshot. If any # data on the snapshot that is marked for deletion is needed for subsequent diff --git a/generated/google/apis/compute_beta.rb b/generated/google/apis/compute_beta.rb index eab109cd1..3edd537da 100644 --- a/generated/google/apis/compute_beta.rb +++ b/generated/google/apis/compute_beta.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/compute/docs/reference/latest/ module ComputeBeta VERSION = 'Beta' - REVISION = '20200311' + REVISION = '20200331' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/compute_beta/classes.rb b/generated/google/apis/compute_beta/classes.rb index d3cd11795..00d870d11 100644 --- a/generated/google/apis/compute_beta/classes.rb +++ b/generated/google/apis/compute_beta/classes.rb @@ -596,9 +596,9 @@ module Google # @return [String] attr_accessor :label_fingerprint - # Labels to apply to this Address resource. These can be later modified by the - # setLabels method. Each label key/value must comply with RFC1035. Label values - # may be empty. + # Labels for this resource. These can only be added or modified by the setLabels + # method. Each label key/value pair must comply with RFC1035. Label values may + # be empty. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -6330,9 +6330,9 @@ module Google # @return [String] attr_accessor :label_fingerprint - # Labels to apply to this ExternalVpnGateway resource. These can be later - # modified by the setLabels method. Each label key/value must comply with - # RFC1035. Label values may be empty. + # Labels for this resource. These can only be added or modified by the setLabels + # method. Each label key/value pair must comply with RFC1035. Label values may + # be empty. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -7149,7 +7149,7 @@ module Google # @return [String] attr_accessor :label_fingerprint - # Labels to apply to this resource. These can be later modified by the setLabels + # Labels for this resource. These can only be added or modified by the setLabels # method. Each label key/value pair must comply with RFC1035. Label values may # be empty. # Corresponds to the JSON property `labels` @@ -11129,7 +11129,10 @@ module Google # @return [Array] attr_accessor :named_ports - # The URL of the network to which all instances in the instance group belong. + # [Output Only] The URL of the network to which all instances in the instance + # group belong. If your instance has multiple network interfaces, then the + # network and subnetwork fields only refer to the network and subnet used by + # your primary interface (nic0). # Corresponds to the JSON property `network` # @return [String] attr_accessor :network @@ -11151,7 +11154,9 @@ module Google attr_accessor :size # [Output Only] The URL of the subnetwork to which all instances in the instance - # group belong. + # group belong. If your instance has multiple network interfaces, then the + # network and subnetwork fields only refer to the network and subnet used by + # your primary interface (nic0). # Corresponds to the JSON property `subnetwork` # @return [String] attr_accessor :subnetwork @@ -14317,9 +14322,9 @@ module Google # @return [String] attr_accessor :label_fingerprint - # Labels to apply to this Interconnect resource. These can be later modified by - # the setLabels method. Each label key/value must comply with RFC1035. Label - # values may be empty. + # Labels for this resource. These can only be added or modified by the setLabels + # method. Each label key/value pair must comply with RFC1035. Label values may + # be empty. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -14557,9 +14562,9 @@ module Google # @return [String] attr_accessor :label_fingerprint - # Labels to apply to this InterconnectAttachment resource. These can be later - # modified by the setLabels method. Each label key/value must comply with - # RFC1035. Label values may be empty. + # Labels for this resource. These can only be added or modified by the setLabels + # method. Each label key/value pair must comply with RFC1035. Label values may + # be empty. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -27287,9 +27292,9 @@ module Google # @return [String] attr_accessor :label_fingerprint - # Labels to apply to this security policy resource. These can be later modified - # by the setLabels method. Each label key/value must comply with RFC1035. Label - # values may be empty. + # Labels for this resource. These can only be added or modified by the setLabels + # method. Each label key/value pair must comply with RFC1035. Label values may + # be empty. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -32742,9 +32747,9 @@ module Google # @return [String] attr_accessor :label_fingerprint - # Labels to apply to this TargetVpnGateway resource. These can be later modified - # by the setLabels method. Each label key/value must comply with RFC1035. Label - # values may be empty. + # Labels for this resource. These can only be added or modified by the setLabels + # method. Each label key/value pair must comply with RFC1035. Label values may + # be empty. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -34320,9 +34325,9 @@ module Google # @return [String] attr_accessor :label_fingerprint - # Labels to apply to this VpnGateway resource. These can be later modified by - # the setLabels method. Each label key/value must comply with RFC1035. Label - # values may be empty. + # Labels for this resource. These can only be added or modified by the setLabels + # method. Each label key/value pair must comply with RFC1035. Label values may + # be empty. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -34353,7 +34358,7 @@ module Google # @return [String] attr_accessor :self_link - # [Output Only] A list of interfaces on this VPN gateway. + # A list of interfaces on this VPN gateway. # Corresponds to the JSON property `vpnInterfaces` # @return [Array] attr_accessor :vpn_interfaces @@ -34745,7 +34750,7 @@ module Google # @return [Fixnum] attr_accessor :id - # The external IP address for this VPN gateway interface. + # [Output Only] The external IP address for this VPN gateway interface. # Corresponds to the JSON property `ipAddress` # @return [String] attr_accessor :ip_address @@ -34922,9 +34927,9 @@ module Google # @return [String] attr_accessor :label_fingerprint - # Labels to apply to this VpnTunnel. These can be later modified by the - # setLabels method. Each label key/value pair must comply with RFC1035. Label - # values may be empty. + # Labels for this resource. These can only be added or modified by the setLabels + # method. Each label key/value pair must comply with RFC1035. Label values may + # be empty. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels diff --git a/generated/google/apis/compute_beta/service.rb b/generated/google/apis/compute_beta/service.rb index 31b489b3d..4ba5b0d33 100644 --- a/generated/google/apis/compute_beta/service.rb +++ b/generated/google/apis/compute_beta/service.rb @@ -1770,6 +1770,8 @@ module Google end # Gets the most recent health check results for this BackendService. + # Example request body: + # ` "group": "/zones/us-east1-b/instanceGroups/lb-backend-example" ` # @param [String] project # @param [String] backend_service # Name of the BackendService resource to which the queried instance belongs. @@ -15588,7 +15590,7 @@ module Google execute_or_queue_command(command, &block) end - # Patch the node group. + # Updates the specified node group. # @param [String] project # Project ID for this request. # @param [String] zone diff --git a/generated/google/apis/compute_v1.rb b/generated/google/apis/compute_v1.rb index c19095ef6..3923ac49b 100644 --- a/generated/google/apis/compute_v1.rb +++ b/generated/google/apis/compute_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/compute/docs/reference/latest/ module ComputeV1 VERSION = 'V1' - REVISION = '20200311' + REVISION = '20200331' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/compute_v1/classes.rb b/generated/google/apis/compute_v1/classes.rb index cd76e173e..0adbc93fe 100644 --- a/generated/google/apis/compute_v1/classes.rb +++ b/generated/google/apis/compute_v1/classes.rb @@ -5911,9 +5911,9 @@ module Google # @return [String] attr_accessor :label_fingerprint - # Labels to apply to this ExternalVpnGateway resource. These can be later - # modified by the setLabels method. Each label key/value must comply with - # RFC1035. Label values may be empty. + # Labels for this resource. These can only be added or modified by the setLabels + # method. Each label key/value pair must comply with RFC1035. Label values may + # be empty. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -10307,7 +10307,10 @@ module Google # @return [Array] attr_accessor :named_ports - # The URL of the network to which all instances in the instance group belong. + # [Output Only] The URL of the network to which all instances in the instance + # group belong. If your instance has multiple network interfaces, then the + # network and subnetwork fields only refer to the network and subnet used by + # your primary interface (nic0). # Corresponds to the JSON property `network` # @return [String] attr_accessor :network @@ -10329,7 +10332,9 @@ module Google attr_accessor :size # [Output Only] The URL of the subnetwork to which all instances in the instance - # group belong. + # group belong. If your instance has multiple network interfaces, then the + # network and subnetwork fields only refer to the network and subnet used by + # your primary interface (nic0). # Corresponds to the JSON property `subnetwork` # @return [String] attr_accessor :subnetwork @@ -16815,12 +16820,30 @@ module Google attr_accessor :export_custom_routes alias_method :export_custom_routes?, :export_custom_routes + # Whether subnet routes with public IP range are exported. The default value is + # true, all subnet routes are exported. The IPv4 special-use ranges (https://en. + # wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and + # are not controlled by this field. + # Corresponds to the JSON property `exportSubnetRoutesWithPublicIp` + # @return [Boolean] + attr_accessor :export_subnet_routes_with_public_ip + alias_method :export_subnet_routes_with_public_ip?, :export_subnet_routes_with_public_ip + # Whether to import the custom routes from peer network. # Corresponds to the JSON property `importCustomRoutes` # @return [Boolean] attr_accessor :import_custom_routes alias_method :import_custom_routes?, :import_custom_routes + # Whether subnet routes with public IP range are imported. The default value is + # false. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4# + # Special_addresses) are always imported from peers and are not controlled by + # this field. + # Corresponds to the JSON property `importSubnetRoutesWithPublicIp` + # @return [Boolean] + attr_accessor :import_subnet_routes_with_public_ip + alias_method :import_subnet_routes_with_public_ip?, :import_subnet_routes_with_public_ip + # Name of this peering. Provided by the client when the peering is created. The # name must comply with RFC1035. Specifically, the name must be 1-63 characters # long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first @@ -16859,7 +16882,9 @@ module Google @auto_create_routes = args[:auto_create_routes] if args.key?(:auto_create_routes) @exchange_subnet_routes = args[:exchange_subnet_routes] if args.key?(:exchange_subnet_routes) @export_custom_routes = args[:export_custom_routes] if args.key?(:export_custom_routes) + @export_subnet_routes_with_public_ip = args[:export_subnet_routes_with_public_ip] if args.key?(:export_subnet_routes_with_public_ip) @import_custom_routes = args[:import_custom_routes] if args.key?(:import_custom_routes) + @import_subnet_routes_with_public_ip = args[:import_subnet_routes_with_public_ip] if args.key?(:import_subnet_routes_with_public_ip) @name = args[:name] if args.key?(:name) @network = args[:network] if args.key?(:network) @state = args[:state] if args.key?(:state) @@ -25628,6 +25653,11 @@ module Google # @return [String] attr_accessor :description + # [Output Only] Expire time of the certificate. RFC3339 + # Corresponds to the JSON property `expireTime` + # @return [String] + attr_accessor :expire_time + # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` @@ -25640,6 +25670,11 @@ module Google # @return [String] attr_accessor :kind + # Configuration and status of a managed SSL certificate. + # Corresponds to the JSON property `managed` + # @return [Google::Apis::ComputeV1::SslCertificateManagedSslCertificate] + attr_accessor :managed + # Name of the resource. Provided by the client when the resource is created. The # name must be 1-63 characters long, and comply with RFC1035. Specifically, the # name must be 1-63 characters long and match the regular expression `[a-z]([-a- @@ -25667,6 +25702,24 @@ module Google # @return [String] attr_accessor :self_link + # Configuration and status of a self-managed SSL certificate. + # Corresponds to the JSON property `selfManaged` + # @return [Google::Apis::ComputeV1::SslCertificateSelfManagedSslCertificate] + attr_accessor :self_managed + + # [Output Only] Domains associated with the certificate via Subject Alternative + # Name. + # Corresponds to the JSON property `subjectAlternativeNames` + # @return [Array] + attr_accessor :subject_alternative_names + + # (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or " + # MANAGED". If not specified, the certificate is self-managed and the fields + # certificate and private_key are used. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + def initialize(**args) update!(**args) end @@ -25676,12 +25729,17 @@ module Google @certificate = args[:certificate] if args.key?(:certificate) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) + @expire_time = args[:expire_time] if args.key?(:expire_time) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) + @managed = args[:managed] if args.key?(:managed) @name = args[:name] if args.key?(:name) @private_key = args[:private_key] if args.key?(:private_key) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) + @self_managed = args[:self_managed] if args.key?(:self_managed) + @subject_alternative_names = args[:subject_alternative_names] if args.key?(:subject_alternative_names) + @type = args[:type] if args.key?(:type) end end @@ -25920,6 +25978,67 @@ module Google end end + # Configuration and status of a managed SSL certificate. + class SslCertificateManagedSslCertificate + include Google::Apis::Core::Hashable + + # [Output only] Detailed statuses of the domains specified for managed + # certificate resource. + # Corresponds to the JSON property `domainStatus` + # @return [Hash] + attr_accessor :domain_status + + # The domains for which a managed SSL certificate will be generated. Currently + # only single-domain certs are supported. + # Corresponds to the JSON property `domains` + # @return [Array] + attr_accessor :domains + + # [Output only] Status of the managed certificate resource. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @domain_status = args[:domain_status] if args.key?(:domain_status) + @domains = args[:domains] if args.key?(:domains) + @status = args[:status] if args.key?(:status) + end + end + + # Configuration and status of a self-managed SSL certificate. + class SslCertificateSelfManagedSslCertificate + include Google::Apis::Core::Hashable + + # A local certificate file. The certificate must be in PEM format. The + # certificate chain must be no greater than 5 certs long. The chain must include + # at least one intermediate cert. + # Corresponds to the JSON property `certificate` + # @return [String] + attr_accessor :certificate + + # A write-only private key in PEM format. Only insert requests will include this + # field. + # Corresponds to the JSON property `privateKey` + # @return [String] + attr_accessor :private_key + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @certificate = args[:certificate] if args.key?(:certificate) + @private_key = args[:private_key] if args.key?(:private_key) + end + end + # class SslCertificatesScopedList include Google::Apis::Core::Hashable @@ -30987,9 +31106,9 @@ module Google # @return [String] attr_accessor :label_fingerprint - # Labels to apply to this VpnGateway resource. These can be later modified by - # the setLabels method. Each label key/value must comply with RFC1035. Label - # values may be empty. + # Labels for this resource. These can only be added or modified by the setLabels + # method. Each label key/value pair must comply with RFC1035. Label values may + # be empty. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -31020,7 +31139,7 @@ module Google # @return [String] attr_accessor :self_link - # [Output Only] A list of interfaces on this VPN gateway. + # A list of interfaces on this VPN gateway. # Corresponds to the JSON property `vpnInterfaces` # @return [Array] attr_accessor :vpn_interfaces @@ -31412,7 +31531,7 @@ module Google # @return [Fixnum] attr_accessor :id - # The external IP address for this VPN gateway interface. + # [Output Only] The external IP address for this VPN gateway interface. # Corresponds to the JSON property `ipAddress` # @return [String] attr_accessor :ip_address diff --git a/generated/google/apis/compute_v1/representations.rb b/generated/google/apis/compute_v1/representations.rb index b0371de8d..414b548c0 100644 --- a/generated/google/apis/compute_v1/representations.rb +++ b/generated/google/apis/compute_v1/representations.rb @@ -3514,6 +3514,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class SslCertificateManagedSslCertificate + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SslCertificateSelfManagedSslCertificate + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SslCertificatesScopedList class Representation < Google::Apis::Core::JsonRepresentation; end @@ -8552,7 +8564,9 @@ module Google property :auto_create_routes, as: 'autoCreateRoutes' property :exchange_subnet_routes, as: 'exchangeSubnetRoutes' property :export_custom_routes, as: 'exportCustomRoutes' + property :export_subnet_routes_with_public_ip, as: 'exportSubnetRoutesWithPublicIp' property :import_custom_routes, as: 'importCustomRoutes' + property :import_subnet_routes_with_public_ip, as: 'importSubnetRoutesWithPublicIp' property :name, as: 'name' property :network, as: 'network' property :state, as: 'state' @@ -10826,12 +10840,19 @@ module Google property :certificate, as: 'certificate' property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' + property :expire_time, as: 'expireTime' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' + property :managed, as: 'managed', class: Google::Apis::ComputeV1::SslCertificateManagedSslCertificate, decorator: Google::Apis::ComputeV1::SslCertificateManagedSslCertificate::Representation + property :name, as: 'name' property :private_key, as: 'privateKey' property :region, as: 'region' property :self_link, as: 'selfLink' + property :self_managed, as: 'selfManaged', class: Google::Apis::ComputeV1::SslCertificateSelfManagedSslCertificate, decorator: Google::Apis::ComputeV1::SslCertificateSelfManagedSslCertificate::Representation + + collection :subject_alternative_names, as: 'subjectAlternativeNames' + property :type, as: 'type' end end @@ -10899,6 +10920,23 @@ module Google end end + class SslCertificateManagedSslCertificate + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :domain_status, as: 'domainStatus' + collection :domains, as: 'domains' + property :status, as: 'status' + end + end + + class SslCertificateSelfManagedSslCertificate + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :certificate, as: 'certificate' + property :private_key, as: 'privateKey' + end + end + class SslCertificatesScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/compute_v1/service.rb b/generated/google/apis/compute_v1/service.rb index 1e6a6ccb6..1f15f18d8 100644 --- a/generated/google/apis/compute_v1/service.rb +++ b/generated/google/apis/compute_v1/service.rb @@ -1631,6 +1631,8 @@ module Google end # Gets the most recent health check results for this BackendService. + # Example request body: + # ` "group": "/zones/us-east1-b/instanceGroups/lb-backend-example" ` # @param [String] project # @param [String] backend_service # Name of the BackendService resource to which the queried instance belongs. @@ -13486,7 +13488,7 @@ module Google execute_or_queue_command(command, &block) end - # Patch the node group. + # Updates the specified node group. # @param [String] project # Project ID for this request. # @param [String] zone diff --git a/generated/google/apis/container_v1.rb b/generated/google/apis/container_v1.rb index 10986aade..5600f9c73 100644 --- a/generated/google/apis/container_v1.rb +++ b/generated/google/apis/container_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/container-engine/ module ContainerV1 VERSION = 'V1' - REVISION = '20200324' + REVISION = '20200425' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/container_v1/classes.rb b/generated/google/apis/container_v1/classes.rb index 4816f879a..4b0b9c94d 100644 --- a/generated/google/apis/container_v1/classes.rb +++ b/generated/google/apis/container_v1/classes.rb @@ -32,7 +32,7 @@ module Google attr_accessor :accelerator_count # The accelerator type resource name. List of supported accelerators - # [here](/compute/docs/gpus) + # [here](https://cloud.google.com/compute/docs/gpus) # Corresponds to the JSON property `acceleratorType` # @return [String] attr_accessor :accelerator_type @@ -257,7 +257,7 @@ module Google include Google::Apis::Core::Hashable # The name (project, location, operation id) of the operation to cancel. - # Specified in the format 'projects/*/locations/*/operations/*'. + # Specified in the format `projects/*/locations/*/operations/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -276,8 +276,9 @@ module Google attr_accessor :project_id # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the operation resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # operation resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -419,8 +420,8 @@ module Google attr_accessor :current_node_count # [Output only] Deprecated, use - # [NodePools.version](/kubernetes-engine/docs/reference/rest/v1/projects.zones. - # clusters.nodePools) + # [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/ + # rest/v1/projects.zones.clusters.nodePools) # instead. The current version of the node software components. If they are # currently at multiple versions because they're in the process of being # upgraded, this reflects the minimum version of all nodes. @@ -525,16 +526,19 @@ module Google attr_accessor :legacy_abac # [Output only] The name of the Google Compute Engine - # [zone](/compute/docs/regions-zones/regions-zones#available) or - # [region](/compute/docs/regions-zones/regions-zones#available) in which - # the cluster resides. + # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones# + # available) + # or + # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones# + # available) + # in which the cluster resides. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # The list of Google Compute Engine - # [zones](/compute/docs/zones#available) in which the cluster's nodes - # should be located. + # [zones](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster's nodes should be located. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations @@ -596,9 +600,10 @@ module Google attr_accessor :name # The name of the Google Compute Engine - # [network](/compute/docs/networks-and-firewalls#networks) to which the - # cluster is connected. If left unspecified, the `default` network - # will be used. + # [network](https://cloud.google.com/compute/docs/networks-and-firewalls# + # networks) + # to which the cluster is connected. If left unspecified, the `default` + # network will be used. # Corresponds to the JSON property `network` # @return [String] attr_accessor :network @@ -681,8 +686,8 @@ module Google attr_accessor :status_message # The name of the Google Compute Engine - # [subnetwork](/compute/docs/subnetworks) to which the - # cluster is connected. + # [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which + # the cluster is connected. # Corresponds to the JSON property `subnetwork` # @return [String] attr_accessor :subnetwork @@ -708,9 +713,8 @@ module Google attr_accessor :workload_identity_config # [Output only] The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field is deprecated, use location instead. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field is deprecated, use location instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -781,8 +785,9 @@ module Google class ClusterAutoscaling include Google::Apis::Core::Hashable - # The list of Google Compute Engine [zones](/compute/docs/zones#available) - # in which the NodePool's nodes can be created by NAP. + # The list of Google Compute Engine + # [zones](https://cloud.google.com/compute/docs/zones#available) in which the + # NodePool's nodes can be created by NAP. # Corresponds to the JSON property `autoprovisioningLocations` # @return [Array] attr_accessor :autoprovisioning_locations @@ -861,10 +866,10 @@ module Google attr_accessor :desired_intra_node_visibility_config # The desired list of Google Compute Engine - # [zones](/compute/docs/zones#available) in which the cluster's nodes - # should be located. Changing the locations a cluster is in will result - # in nodes being either created or removed from the cluster, depending on - # whether locations are being added or removed. + # [zones](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster's nodes should be located. Changing the locations a cluster is in + # will result in nodes being either created or removed from the cluster, + # depending on whether locations are being added or removed. # This list must always include the cluster's primary zone. # Corresponds to the JSON property `desiredLocations` # @return [Array] @@ -1004,7 +1009,7 @@ module Google attr_accessor :cluster_id # The name (project, location, cluster id) of the cluster to complete IP - # rotation. Specified in the format 'projects/*/locations/*/clusters/*'. + # rotation. Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1017,9 +1022,9 @@ module Google attr_accessor :project_id # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -1069,7 +1074,7 @@ module Google attr_accessor :cluster # The parent (project and location) where the cluster will be created. - # Specified in the format 'projects/*/locations/*'. + # Specified in the format `projects/*/locations/*`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -1082,9 +1087,9 @@ module Google attr_accessor :project_id # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the parent field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the parent + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -1124,7 +1129,7 @@ module Google # The parent (project, location, cluster id) where the node pool will be # created. Specified in the format - # 'projects/*/locations/*/clusters/*'. + # `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -1137,9 +1142,9 @@ module Google attr_accessor :project_id # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the parent field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the parent + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -1989,16 +1994,17 @@ module Google alias_method :enable_intra_node_visibility?, :enable_intra_node_visibility # Output only. The relative name of the Google Compute Engine - # network(/compute/docs/networks-and-firewalls#networks) to which - # the cluster is connected. - # Example: projects/my-project/global/networks/my-network + # network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) + # to which the cluster is connected. Example: + # projects/my-project/global/networks/my-network # Corresponds to the JSON property `network` # @return [String] attr_accessor :network # Output only. The relative name of the Google Compute Engine - # [subnetwork](/compute/docs/vpc) to which the cluster is connected. - # Example: projects/my-project/regions/us-central1/subnetworks/my-subnet + # [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the + # cluster is connected. Example: + # projects/my-project/regions/us-central1/subnetworks/my-subnet # Corresponds to the JSON property `subnetwork` # @return [String] attr_accessor :subnetwork @@ -2116,7 +2122,7 @@ module Google attr_accessor :local_ssd_count # The name of a Google Compute Engine [machine - # type](/compute/docs/machine-types) (e.g. + # type](https://cloud.google.com/compute/docs/machine-types) (e.g. # `n1-standard-1`). # If unspecified, the default machine type is # `n1-standard-1`. @@ -2177,7 +2183,8 @@ module Google # persistent storage on your nodes. # * `https://www.googleapis.com/auth/devstorage.read_only` is required for # communicating with **gcr.io** - # (the [Google Container Registry](/container-registry/)). + # (the [Google Container + # Registry](https://cloud.google.com/container-registry/)). # If unspecified, no scopes are added, unless Cloud Logging or Cloud # Monitoring are enabled, in which case their required scopes will be added. # Corresponds to the JSON property `oauthScopes` @@ -2192,8 +2199,9 @@ module Google attr_accessor :preemptible alias_method :preemptible?, :preemptible - # [ReservationAffinity](/compute/docs/instances/reserving-zonal-resources) is - # the configuration of desired reservation which instances could take + # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/ + # reserving-zonal-resources) + # is the configuration of desired reservation which instances could take # capacity from. # Corresponds to the JSON property `reservationAffinity` # @return [Google::Apis::ContainerV1::ReservationAffinity] @@ -2338,14 +2346,16 @@ module Google attr_accessor :initial_node_count # [Output only] The resource URLs of the [managed instance - # groups](/compute/docs/instance-groups/creating-groups-of-managed-instances) + # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups- + # of-managed-instances) # associated with this node pool. # Corresponds to the JSON property `instanceGroupUrls` # @return [Array] attr_accessor :instance_group_urls - # The list of Google Compute Engine [zones](/compute/docs/zones#available) - # in which the NodePool's nodes should be located. + # The list of Google Compute Engine + # [zones](https://cloud.google.com/compute/docs/zones#available) in which the + # NodePool's nodes should be located. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations @@ -2536,9 +2546,12 @@ module Google attr_accessor :end_time # [Output only] The name of the Google Compute Engine - # [zone](/compute/docs/regions-zones/regions-zones#available) or - # [region](/compute/docs/regions-zones/regions-zones#available) in which - # the cluster resides. + # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones# + # available) + # or + # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones# + # available) + # in which the cluster resides. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location @@ -2590,9 +2603,8 @@ module Google attr_accessor :target_link # The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the operation - # is taking place. - # This field is deprecated, use location instead. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # operation is taking place. This field is deprecated, use location instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -2770,8 +2782,9 @@ module Google end end - # [ReservationAffinity](/compute/docs/instances/reserving-zonal-resources) is - # the configuration of desired reservation which instances could take + # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/ + # reserving-zonal-resources) + # is the configuration of desired reservation which instances could take # capacity from. class ReservationAffinity include Google::Apis::Core::Hashable @@ -2884,7 +2897,7 @@ module Google # The name (project, location, cluster, node pool id) of the node poll to # rollback upgrade. - # Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'. + # Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2903,9 +2916,9 @@ module Google attr_accessor :project_id # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3003,7 +3016,7 @@ module Google attr_accessor :cluster_id # The name (project, location, cluster) of the cluster to set addons. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3016,9 +3029,9 @@ module Google attr_accessor :project_id # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3060,7 +3073,7 @@ module Google attr_accessor :label_fingerprint # The name (project, location, cluster id) of the cluster to set labels. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3078,9 +3091,9 @@ module Google attr_accessor :resource_labels # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3118,7 +3131,7 @@ module Google alias_method :enabled?, :enabled # The name (project, location, cluster id) of the cluster to set legacy abac. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3131,9 +3144,9 @@ module Google attr_accessor :project_id # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3163,17 +3176,17 @@ module Google attr_accessor :cluster_id # Required. The desired list of Google Compute Engine - # [zones](/compute/docs/zones#available) in which the cluster's nodes - # should be located. Changing the locations a cluster is in will result - # in nodes being either created or removed from the cluster, depending on - # whether locations are being added or removed. + # [zones](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster's nodes should be located. Changing the locations a cluster is in + # will result in nodes being either created or removed from the cluster, + # depending on whether locations are being added or removed. # This list must always include the cluster's primary zone. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations # The name (project, location, cluster) of the cluster to set locations. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3186,9 +3199,9 @@ module Google attr_accessor :project_id # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3231,7 +3244,7 @@ module Google attr_accessor :logging_service # The name (project, location, cluster) of the cluster to set logging. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3244,9 +3257,9 @@ module Google attr_accessor :project_id # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3281,7 +3294,7 @@ module Google # The name (project, location, cluster id) of the cluster to set maintenance # policy. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3293,8 +3306,8 @@ module Google attr_accessor :project_id # Required. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3329,7 +3342,7 @@ module Google attr_accessor :cluster_id # The name (project, location, cluster) of the cluster to set auth. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3349,9 +3362,9 @@ module Google attr_accessor :update # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3395,7 +3408,7 @@ module Google attr_accessor :monitoring_service # The name (project, location, cluster) of the cluster to set monitoring. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3408,9 +3421,9 @@ module Google attr_accessor :project_id # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3440,7 +3453,7 @@ module Google attr_accessor :cluster_id # The name (project, location, cluster id) of the cluster to set networking - # policy. Specified in the format 'projects/*/locations/*/clusters/*'. + # policy. Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3459,9 +3472,9 @@ module Google attr_accessor :project_id # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3498,7 +3511,7 @@ module Google # The name (project, location, cluster, node pool) of the node pool to set # autoscaler settings. Specified in the format - # 'projects/*/locations/*/clusters/*/nodePools/*'. + # `projects/*/locations/*/clusters/*/nodePools/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3517,9 +3530,9 @@ module Google attr_accessor :project_id # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3558,7 +3571,7 @@ module Google # The name (project, location, cluster, node pool id) of the node pool to set # management properties. Specified in the format - # 'projects/*/locations/*/clusters/*/nodePools/*'. + # `projects/*/locations/*/clusters/*/nodePools/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3577,9 +3590,9 @@ module Google attr_accessor :project_id # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3612,7 +3625,7 @@ module Google # The name (project, location, cluster, node pool id) of the node pool to set # size. - # Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'. + # Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3636,9 +3649,9 @@ module Google attr_accessor :project_id # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3724,7 +3737,7 @@ module Google attr_accessor :cluster_id # The name (project, location, cluster id) of the cluster to start IP - # rotation. Specified in the format 'projects/*/locations/*/clusters/*'. + # rotation. Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3743,9 +3756,9 @@ module Google alias_method :rotate_credentials?, :rotate_credentials # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3827,7 +3840,7 @@ module Google attr_accessor :cluster_id # The name (project, location, cluster) of the cluster to update. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3847,9 +3860,9 @@ module Google attr_accessor :update # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3891,7 +3904,7 @@ module Google attr_accessor :master_version # The name (project, location, cluster) of the cluster to update. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3904,9 +3917,9 @@ module Google attr_accessor :project_id # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3941,17 +3954,17 @@ module Google attr_accessor :image_type # The desired list of Google Compute Engine - # [zones](/compute/docs/zones#available) in which the node pool's nodes - # should be located. Changing the locations for a node pool will result - # in nodes being either created or removed from the node pool, depending - # on whether locations are being added or removed. + # [zones](https://cloud.google.com/compute/docs/zones#available) in which the + # node pool's nodes should be located. Changing the locations for a node pool + # will result in nodes being either created or removed from the node pool, + # depending on whether locations are being added or removed. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations # The name (project, location, cluster, node pool) of the node pool to # update. Specified in the format - # 'projects/*/locations/*/clusters/*/nodePools/*'. + # `projects/*/locations/*/clusters/*/nodePools/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4011,9 +4024,9 @@ module Google attr_accessor :workload_metadata_config # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone diff --git a/generated/google/apis/container_v1/service.rb b/generated/google/apis/container_v1/service.rb index 1ef334016..3af0581c9 100644 --- a/generated/google/apis/container_v1/service.rb +++ b/generated/google/apis/container_v1/service.rb @@ -51,7 +51,7 @@ module Google # Lists subnetworks that are usable for creating clusters in a project. # @param [String] parent # The parent project where subnetworks are usable. - # Specified in the format 'projects/*'. + # Specified in the format `projects/*`. # @param [String] filter # Filtering currently only supports equality on the networkProjectId and must # be in the form: "networkProjectId=[PROJECTID]", where `networkProjectId` @@ -98,15 +98,16 @@ module Google # Returns configuration info about the Google Kubernetes Engine service. # @param [String] name # The name (project and location) of the server config to get, - # specified in the format 'projects/*/locations/*'. + # specified in the format `projects/*/locations/*`. # @param [String] project_id # Deprecated. The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) to return operations for. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) to return + # operations for. This field has been deprecated and replaced by the name + # field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -139,7 +140,7 @@ module Google # Completes master IP rotation. # @param [String] name # The name (project, location, cluster id) of the cluster to complete IP - # rotation. Specified in the format 'projects/*/locations/*/clusters/*'. + # rotation. Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1::CompleteIpRotationRequest] complete_ip_rotation_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -173,7 +174,9 @@ module Google # Creates a cluster, consisting of the specified number and type of Google # Compute Engine instances. # By default, the cluster is created in the project's - # [default network](/compute/docs/networks-and-firewalls#networks). + # [default + # network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) + # . # One firewall is added for the cluster. After cluster creation, # the Kubelet creates routes for each node to allow the containers # on that node to communicate with all other instances in the @@ -182,7 +185,7 @@ module Google # which CIDR range the cluster is using. # @param [String] parent # The parent (project and location) where the cluster will be created. - # Specified in the format 'projects/*/locations/*'. + # Specified in the format `projects/*/locations/*`. # @param [Google::Apis::ContainerV1::CreateClusterRequest] create_cluster_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -222,7 +225,7 @@ module Google # when the cluster was initially created. # @param [String] name # The name (project, location, cluster) of the cluster to delete. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [String] cluster_id # Deprecated. The name of the cluster to delete. # This field has been deprecated and replaced by the name field. @@ -232,9 +235,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -268,7 +271,7 @@ module Google # Gets the details of a specific cluster. # @param [String] name # The name (project, location, cluster) of the cluster to retrieve. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [String] cluster_id # Deprecated. The name of the cluster to retrieve. # This field has been deprecated and replaced by the name field. @@ -278,9 +281,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -317,7 +320,7 @@ module Google # clusters. # @param [String] parent # The cluster (project, location, cluster id) to get keys for. Specified in - # the format 'projects/*/locations/*/clusters/*'. + # the format `projects/*/locations/*/clusters/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -349,7 +352,7 @@ module Google # zones. # @param [String] parent # The parent (project and location) where the clusters will be listed. - # Specified in the format 'projects/*/locations/*'. + # Specified in the format `projects/*/locations/*`. # Location "-" matches all zones and all regions. # @param [String] project_id # Deprecated. The Google Developers Console [project ID or project @@ -357,9 +360,9 @@ module Google # This field has been deprecated and replaced by the parent field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides, or "-" for all zones. - # This field has been deprecated and replaced by the parent field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides, or "-" for all zones. This field has been deprecated and + # replaced by the parent field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -392,7 +395,7 @@ module Google # Sets the addons for a specific cluster. # @param [String] name # The name (project, location, cluster) of the cluster to set addons. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1::SetAddonsConfigRequest] set_addons_config_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -426,7 +429,7 @@ module Google # Enables or disables the ABAC authorization mechanism on a cluster. # @param [String] name # The name (project, location, cluster id) of the cluster to set legacy abac. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1::SetLegacyAbacRequest] set_legacy_abac_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -459,12 +462,12 @@ module Google # Sets the locations for a specific cluster. # Deprecated. Use - # [projects.locations.clusters.update](/kubernetes-engine/docs/reference/rest/v1/ - # projects.locations.clusters/update) + # [projects.locations.clusters.update](https://cloud.google.com/kubernetes- + # engine/docs/reference/rest/v1/projects.locations.clusters/update) # instead. # @param [String] name # The name (project, location, cluster) of the cluster to set locations. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1::SetLocationsRequest] set_locations_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -498,7 +501,7 @@ module Google # Sets the logging service for a specific cluster. # @param [String] name # The name (project, location, cluster) of the cluster to set logging. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1::SetLoggingServiceRequest] set_logging_service_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -533,7 +536,7 @@ module Google # @param [String] name # The name (project, location, cluster id) of the cluster to set maintenance # policy. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1::SetMaintenancePolicyRequest] set_maintenance_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -569,7 +572,7 @@ module Google # the password. # @param [String] name # The name (project, location, cluster) of the cluster to set auth. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1::SetMasterAuthRequest] set_master_auth_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -603,7 +606,7 @@ module Google # Sets the monitoring service for a specific cluster. # @param [String] name # The name (project, location, cluster) of the cluster to set monitoring. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1::SetMonitoringServiceRequest] set_monitoring_service_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -637,7 +640,7 @@ module Google # Enables or disables Network Policy for a cluster. # @param [String] name # The name (project, location, cluster id) of the cluster to set networking - # policy. Specified in the format 'projects/*/locations/*/clusters/*'. + # policy. Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1::SetNetworkPolicyRequest] set_network_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -671,7 +674,7 @@ module Google # Sets labels on a cluster. # @param [String] name # The name (project, location, cluster id) of the cluster to set labels. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1::SetLabelsRequest] set_labels_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -705,7 +708,7 @@ module Google # Starts master IP rotation. # @param [String] name # The name (project, location, cluster id) of the cluster to start IP - # rotation. Specified in the format 'projects/*/locations/*/clusters/*'. + # rotation. Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1::StartIpRotationRequest] start_ip_rotation_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -739,7 +742,7 @@ module Google # Updates the settings of a specific cluster. # @param [String] name # The name (project, location, cluster) of the cluster to update. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1::UpdateClusterRequest] update_cluster_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -773,7 +776,7 @@ module Google # Updates the master for a specific cluster. # @param [String] name # The name (project, location, cluster) of the cluster to update. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1::UpdateMasterRequest] update_master_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -808,7 +811,7 @@ module Google # @param [String] parent # The parent (project, location, cluster id) where the node pool will be # created. Specified in the format - # 'projects/*/locations/*/clusters/*'. + # `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1::CreateNodePoolRequest] create_node_pool_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -843,7 +846,7 @@ module Google # @param [String] name # The name (project, location, cluster, node pool id) of the node pool to # delete. Specified in the format - # 'projects/*/locations/*/clusters/*/nodePools/*'. + # `projects/*/locations/*/clusters/*/nodePools/*`. # @param [String] cluster_id # Deprecated. The name of the cluster. # This field has been deprecated and replaced by the name field. @@ -856,9 +859,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -894,7 +897,7 @@ module Google # @param [String] name # The name (project, location, cluster, node pool id) of the node pool to # get. Specified in the format - # 'projects/*/locations/*/clusters/*/nodePools/*'. + # `projects/*/locations/*/clusters/*/nodePools/*`. # @param [String] cluster_id # Deprecated. The name of the cluster. # This field has been deprecated and replaced by the name field. @@ -907,9 +910,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -944,7 +947,7 @@ module Google # Lists the node pools for a cluster. # @param [String] parent # The parent (project, location, cluster id) where the node pools will be - # listed. Specified in the format 'projects/*/locations/*/clusters/*'. + # listed. Specified in the format `projects/*/locations/*/clusters/*`. # @param [String] cluster_id # Deprecated. The name of the cluster. # This field has been deprecated and replaced by the parent field. @@ -954,9 +957,9 @@ module Google # This field has been deprecated and replaced by the parent field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the parent field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the parent + # field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -992,7 +995,7 @@ module Google # @param [String] name # The name (project, location, cluster, node pool id) of the node poll to # rollback upgrade. - # Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'. + # Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. # @param [Google::Apis::ContainerV1::RollbackNodePoolUpgradeRequest] rollback_node_pool_upgrade_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1027,7 +1030,7 @@ module Google # @param [String] name # The name (project, location, cluster, node pool) of the node pool to set # autoscaler settings. Specified in the format - # 'projects/*/locations/*/clusters/*/nodePools/*'. + # `projects/*/locations/*/clusters/*/nodePools/*`. # @param [Google::Apis::ContainerV1::SetNodePoolAutoscalingRequest] set_node_pool_autoscaling_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1062,7 +1065,7 @@ module Google # @param [String] name # The name (project, location, cluster, node pool id) of the node pool to set # management properties. Specified in the format - # 'projects/*/locations/*/clusters/*/nodePools/*'. + # `projects/*/locations/*/clusters/*/nodePools/*`. # @param [Google::Apis::ContainerV1::SetNodePoolManagementRequest] set_node_pool_management_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1097,7 +1100,7 @@ module Google # @param [String] name # The name (project, location, cluster, node pool id) of the node pool to set # size. - # Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'. + # Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. # @param [Google::Apis::ContainerV1::SetNodePoolSizeRequest] set_node_pool_size_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1132,7 +1135,7 @@ module Google # @param [String] name # The name (project, location, cluster, node pool) of the node pool to # update. Specified in the format - # 'projects/*/locations/*/clusters/*/nodePools/*'. + # `projects/*/locations/*/clusters/*/nodePools/*`. # @param [Google::Apis::ContainerV1::UpdateNodePoolRequest] update_node_pool_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1172,7 +1175,7 @@ module Google # clusters. # @param [String] parent # The cluster (project, location, cluster id) to get the discovery document - # for. Specified in the format 'projects/*/locations/*/clusters/*'. + # for. Specified in the format `projects/*/locations/*/clusters/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1203,7 +1206,7 @@ module Google # Cancels the specified operation. # @param [String] name # The name (project, location, operation id) of the operation to cancel. - # Specified in the format 'projects/*/locations/*/operations/*'. + # Specified in the format `projects/*/locations/*/operations/*`. # @param [Google::Apis::ContainerV1::CancelOperationRequest] cancel_operation_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1237,7 +1240,7 @@ module Google # Gets the specified operation. # @param [String] name # The name (project, location, operation id) of the operation to get. - # Specified in the format 'projects/*/locations/*/operations/*'. + # Specified in the format `projects/*/locations/*/operations/*`. # @param [String] operation_id # Deprecated. The server-assigned `name` of the operation. # This field has been deprecated and replaced by the name field. @@ -1247,9 +1250,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1283,7 +1286,7 @@ module Google # Lists all operations in a project in a specific zone or all zones. # @param [String] parent # The parent (project and location) where the operations will be listed. - # Specified in the format 'projects/*/locations/*'. + # Specified in the format `projects/*/locations/*`. # Location "-" matches all zones and all regions. # @param [String] project_id # Deprecated. The Google Developers Console [project ID or project @@ -1291,8 +1294,9 @@ module Google # This field has been deprecated and replaced by the parent field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) to return operations for, or `-` for - # all zones. This field has been deprecated and replaced by the parent field. + # [zone](https://cloud.google.com/compute/docs/zones#available) to return + # operations for, or `-` for all zones. This field has been deprecated and + # replaced by the parent field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1329,11 +1333,12 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) to return operations for. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) to return + # operations for. This field has been deprecated and replaced by the name + # field. # @param [String] name # The name (project and location) of the server config to get, - # specified in the format 'projects/*/locations/*'. + # specified in the format `projects/*/locations/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1370,9 +1375,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Deprecated. The name of the cluster to upgrade. # This field has been deprecated and replaced by the name field. @@ -1415,9 +1420,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Deprecated. The name of the cluster. # This field has been deprecated and replaced by the name field. @@ -1456,7 +1461,9 @@ module Google # Creates a cluster, consisting of the specified number and type of Google # Compute Engine instances. # By default, the cluster is created in the project's - # [default network](/compute/docs/networks-and-firewalls#networks). + # [default + # network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) + # . # One firewall is added for the cluster. After cluster creation, # the Kubelet creates routes for each node to allow the containers # on that node to communicate with all other instances in the @@ -1469,9 +1476,9 @@ module Google # This field has been deprecated and replaced by the parent field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the parent field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the parent + # field. # @param [Google::Apis::ContainerV1::CreateClusterRequest] create_cluster_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1516,15 +1523,15 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Deprecated. The name of the cluster to delete. # This field has been deprecated and replaced by the name field. # @param [String] name # The name (project, location, cluster) of the cluster to delete. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1562,15 +1569,15 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Deprecated. The name of the cluster to retrieve. # This field has been deprecated and replaced by the name field. # @param [String] name # The name (project, location, cluster) of the cluster to retrieve. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1608,9 +1615,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Deprecated. The name of the cluster to update. # This field has been deprecated and replaced by the name field. @@ -1654,12 +1661,12 @@ module Google # This field has been deprecated and replaced by the parent field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides, or "-" for all zones. - # This field has been deprecated and replaced by the parent field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides, or "-" for all zones. This field has been deprecated and + # replaced by the parent field. # @param [String] parent # The parent (project and location) where the clusters will be listed. - # Specified in the format 'projects/*/locations/*'. + # Specified in the format `projects/*/locations/*`. # Location "-" matches all zones and all regions. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1692,8 +1699,8 @@ module Google # Sets the locations for a specific cluster. # Deprecated. Use - # [projects.locations.clusters.update](/kubernetes-engine/docs/reference/rest/v1/ - # projects.locations.clusters/update) + # [projects.locations.clusters.update](https://cloud.google.com/kubernetes- + # engine/docs/reference/rest/v1/projects.locations.clusters/update) # instead. # @param [String] project_id # Deprecated. The Google Developers Console [project ID or project @@ -1701,9 +1708,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Deprecated. The name of the cluster to upgrade. # This field has been deprecated and replaced by the name field. @@ -1746,9 +1753,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Deprecated. The name of the cluster to upgrade. # This field has been deprecated and replaced by the name field. @@ -1791,9 +1798,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Deprecated. The name of the cluster to upgrade. # This field has been deprecated and replaced by the name field. @@ -1836,9 +1843,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Deprecated. The name of the cluster to upgrade. # This field has been deprecated and replaced by the name field. @@ -1881,9 +1888,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Deprecated. The name of the cluster. # This field has been deprecated and replaced by the name field. @@ -1925,8 +1932,8 @@ module Google # number](https://support.google.com/cloud/answer/6158840). # @param [String] zone # Required. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. # @param [String] cluster_id # Required. The name of the cluster to update. # @param [Google::Apis::ContainerV1::SetMaintenancePolicyRequest] set_maintenance_policy_request_object @@ -1970,9 +1977,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Deprecated. The name of the cluster to upgrade. # This field has been deprecated and replaced by the name field. @@ -2015,9 +2022,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Deprecated. The name of the cluster. # This field has been deprecated and replaced by the name field. @@ -2060,9 +2067,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Deprecated. The name of the cluster. # This field has been deprecated and replaced by the name field. @@ -2105,9 +2112,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Deprecated. The name of the cluster to upgrade. # This field has been deprecated and replaced by the name field. @@ -2150,9 +2157,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Deprecated. The name of the cluster to upgrade. # This field has been deprecated and replaced by the name field. @@ -2199,9 +2206,9 @@ module Google # This field has been deprecated and replaced by the parent field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the parent field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the parent + # field. # @param [String] cluster_id # Deprecated. The name of the cluster. # This field has been deprecated and replaced by the parent field. @@ -2244,9 +2251,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Deprecated. The name of the cluster. # This field has been deprecated and replaced by the name field. @@ -2256,7 +2263,7 @@ module Google # @param [String] name # The name (project, location, cluster, node pool id) of the node pool to # delete. Specified in the format - # 'projects/*/locations/*/clusters/*/nodePools/*'. + # `projects/*/locations/*/clusters/*/nodePools/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2295,9 +2302,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Deprecated. The name of the cluster. # This field has been deprecated and replaced by the name field. @@ -2307,7 +2314,7 @@ module Google # @param [String] name # The name (project, location, cluster, node pool id) of the node pool to # get. Specified in the format - # 'projects/*/locations/*/clusters/*/nodePools/*'. + # `projects/*/locations/*/clusters/*/nodePools/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2346,15 +2353,15 @@ module Google # This field has been deprecated and replaced by the parent field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the parent field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the parent + # field. # @param [String] cluster_id # Deprecated. The name of the cluster. # This field has been deprecated and replaced by the parent field. # @param [String] parent # The parent (project, location, cluster id) where the node pools will be - # listed. Specified in the format 'projects/*/locations/*/clusters/*'. + # listed. Specified in the format `projects/*/locations/*/clusters/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2393,9 +2400,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Deprecated. The name of the cluster to rollback. # This field has been deprecated and replaced by the name field. @@ -2442,9 +2449,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Deprecated. The name of the cluster to update. # This field has been deprecated and replaced by the name field. @@ -2491,9 +2498,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Deprecated. The name of the cluster to update. # This field has been deprecated and replaced by the name field. @@ -2540,9 +2547,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Deprecated. The name of the cluster to upgrade. # This field has been deprecated and replaced by the name field. @@ -2589,8 +2596,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the operation resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # operation resides. This field has been deprecated and replaced by the name + # field. # @param [String] operation_id # Deprecated. The server-assigned `name` of the operation. # This field has been deprecated and replaced by the name field. @@ -2633,15 +2641,15 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] operation_id # Deprecated. The server-assigned `name` of the operation. # This field has been deprecated and replaced by the name field. # @param [String] name # The name (project, location, operation id) of the operation to get. - # Specified in the format 'projects/*/locations/*/operations/*'. + # Specified in the format `projects/*/locations/*/operations/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2679,11 +2687,12 @@ module Google # This field has been deprecated and replaced by the parent field. # @param [String] zone # Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) to return operations for, or `-` for - # all zones. This field has been deprecated and replaced by the parent field. + # [zone](https://cloud.google.com/compute/docs/zones#available) to return + # operations for, or `-` for all zones. This field has been deprecated and + # replaced by the parent field. # @param [String] parent # The parent (project and location) where the operations will be listed. - # Specified in the format 'projects/*/locations/*'. + # Specified in the format `projects/*/locations/*`. # Location "-" matches all zones and all regions. # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/container_v1beta1.rb b/generated/google/apis/container_v1beta1.rb index 158176a4c..873005b13 100644 --- a/generated/google/apis/container_v1beta1.rb +++ b/generated/google/apis/container_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/container-engine/ module ContainerV1beta1 VERSION = 'V1beta1' - REVISION = '20200331' + REVISION = '20200425' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/container_v1beta1/classes.rb b/generated/google/apis/container_v1beta1/classes.rb index 2e051cd25..a7bc547dd 100644 --- a/generated/google/apis/container_v1beta1/classes.rb +++ b/generated/google/apis/container_v1beta1/classes.rb @@ -32,7 +32,7 @@ module Google attr_accessor :accelerator_count # The accelerator type resource name. List of supported accelerators - # [here](/compute/docs/gpus) + # [here](https://cloud.google.com/compute/docs/gpus) # Corresponds to the JSON property `acceleratorType` # @return [String] attr_accessor :accelerator_type @@ -58,6 +58,11 @@ module Google # @return [Google::Apis::ContainerV1beta1::CloudRunConfig] attr_accessor :cloud_run_config + # Configuration options for the Config Connector add-on. + # Corresponds to the JSON property `configConnectorConfig` + # @return [Google::Apis::ContainerV1beta1::ConfigConnectorConfig] + attr_accessor :config_connector_config + # Configuration for NodeLocal DNSCache # Corresponds to the JSON property `dnsCacheConfig` # @return [Google::Apis::ContainerV1beta1::DnsCacheConfig] @@ -111,6 +116,7 @@ module Google # Update properties of this object def update!(**args) @cloud_run_config = args[:cloud_run_config] if args.key?(:cloud_run_config) + @config_connector_config = args[:config_connector_config] if args.key?(:config_connector_config) @dns_cache_config = args[:dns_cache_config] if args.key?(:dns_cache_config) @gce_persistent_disk_csi_driver_config = args[:gce_persistent_disk_csi_driver_config] if args.key?(:gce_persistent_disk_csi_driver_config) @horizontal_pod_autoscaling = args[:horizontal_pod_autoscaling] if args.key?(:horizontal_pod_autoscaling) @@ -322,7 +328,7 @@ module Google include Google::Apis::Core::Hashable # The name (project, location, operation id) of the operation to cancel. - # Specified in the format 'projects/*/locations/*/operations/*'. + # Specified in the format `projects/*/locations/*/operations/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -341,8 +347,9 @@ module Google attr_accessor :project_id # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the operation resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # operation resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -489,8 +496,8 @@ module Google attr_accessor :current_node_count # [Output only] Deprecated, use - # [NodePool.version](/kubernetes-engine/docs/reference/rest/v1beta1/projects. - # locations.clusters.nodePools) + # [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/ + # rest/v1beta1/projects.locations.clusters.nodePools) # instead. The current version of the node software components. # If they are currently at multiple versions because they're in the process # of being upgraded, this reflects the minimum version of all nodes. @@ -596,16 +603,19 @@ module Google attr_accessor :legacy_abac # [Output only] The name of the Google Compute Engine - # [zone](/compute/docs/regions-zones/regions-zones#available) or - # [region](/compute/docs/regions-zones/regions-zones#available) in which - # the cluster resides. + # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones# + # available) + # or + # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones# + # available) + # in which the cluster resides. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # The list of Google Compute Engine - # [zones](/compute/docs/zones#available) in which the cluster's nodes - # should be located. + # [zones](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster's nodes should be located. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations @@ -676,10 +686,11 @@ module Google attr_accessor :name # The name of the Google Compute Engine - # [network](/compute/docs/networks-and-firewalls#networks) to which the - # cluster is connected. If left unspecified, the `default` network - # will be used. On output this shows the network ID instead of - # the name. + # [network](https://cloud.google.com/compute/docs/networks-and-firewalls# + # networks) + # to which the cluster is connected. If left unspecified, the `default` + # network will be used. On output this shows the network ID instead of the + # name. # Corresponds to the JSON property `network` # @return [String] attr_accessor :network @@ -788,8 +799,8 @@ module Google attr_accessor :status_message # The name of the Google Compute Engine - # [subnetwork](/compute/docs/subnetworks) to which the - # cluster is connected. On output this shows the subnetwork ID instead of + # [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which + # the cluster is connected. On output this shows the subnetwork ID instead of # the name. # Corresponds to the JSON property `subnetwork` # @return [String] @@ -821,9 +832,8 @@ module Google attr_accessor :workload_identity_config # [Output only] The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field is deprecated, use location instead. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field is deprecated, use location instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -900,8 +910,9 @@ module Google class ClusterAutoscaling include Google::Apis::Core::Hashable - # The list of Google Compute Engine [zones](/compute/docs/zones#available) - # in which the NodePool's nodes can be created by NAP. + # The list of Google Compute Engine + # [zones](https://cloud.google.com/compute/docs/zones#available) in which the + # NodePool's nodes can be created by NAP. # Corresponds to the JSON property `autoprovisioningLocations` # @return [Array] attr_accessor :autoprovisioning_locations @@ -1010,10 +1021,10 @@ module Google attr_accessor :desired_intra_node_visibility_config # The desired list of Google Compute Engine - # [zones](/compute/docs/zones#available) in which the cluster's nodes - # should be located. Changing the locations a cluster is in will result - # in nodes being either created or removed from the cluster, depending on - # whether locations are being added or removed. + # [zones](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster's nodes should be located. Changing the locations a cluster is in + # will result in nodes being either created or removed from the cluster, + # depending on whether locations are being added or removed. # This list must always include the cluster's primary zone. # Corresponds to the JSON property `desiredLocations` # @return [Array] @@ -1185,7 +1196,7 @@ module Google attr_accessor :cluster_id # The name (project, location, cluster id) of the cluster to complete IP - # rotation. Specified in the format 'projects/*/locations/*/clusters/*'. + # rotation. Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1198,9 +1209,9 @@ module Google attr_accessor :project_id # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -1218,6 +1229,26 @@ module Google end end + # Configuration options for the Config Connector add-on. + class ConfigConnectorConfig + include Google::Apis::Core::Hashable + + # Whether Cloud Connector is enabled for this cluster. + # Corresponds to the JSON property `enabled` + # @return [Boolean] + attr_accessor :enabled + alias_method :enabled?, :enabled + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @enabled = args[:enabled] if args.key?(:enabled) + end + end + # Parameters for controlling consumption metering. class ConsumptionMeteringConfig include Google::Apis::Core::Hashable @@ -1250,7 +1281,7 @@ module Google attr_accessor :cluster # The parent (project and location) where the cluster will be created. - # Specified in the format 'projects/*/locations/*'. + # Specified in the format `projects/*/locations/*`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -1263,9 +1294,9 @@ module Google attr_accessor :project_id # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the parent field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the parent + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -1305,7 +1336,7 @@ module Google # The parent (project, location, cluster id) where the node pool will be # created. Specified in the format - # 'projects/*/locations/*/clusters/*'. + # `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -1318,9 +1349,9 @@ module Google attr_accessor :project_id # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the parent field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the parent + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -1748,11 +1779,23 @@ module Google attr_accessor :tpu_ipv4_cidr_block # Whether alias IPs will be used for pod IPs in the cluster. + # This is used in conjunction with use_routes. It cannot + # be true if use_routes is true. If both use_ip_aliases and use_routes are + # false, then the server picks the default IP allocation mode # Corresponds to the JSON property `useIpAliases` # @return [Boolean] attr_accessor :use_ip_aliases alias_method :use_ip_aliases?, :use_ip_aliases + # Whether routes will be used for pod IPs in the cluster. + # This is used in conjunction with use_ip_aliases. It cannot be true if + # use_ip_aliases is true. If both use_ip_aliases and use_routes are false, + # then the server picks the default IP allocation mode + # Corresponds to the JSON property `useRoutes` + # @return [Boolean] + attr_accessor :use_routes + alias_method :use_routes?, :use_routes + def initialize(**args) update!(**args) end @@ -1772,6 +1815,7 @@ module Google @subnetwork_name = args[:subnetwork_name] if args.key?(:subnetwork_name) @tpu_ipv4_cidr_block = args[:tpu_ipv4_cidr_block] if args.key?(:tpu_ipv4_cidr_block) @use_ip_aliases = args[:use_ip_aliases] if args.key?(:use_ip_aliases) + @use_routes = args[:use_routes] if args.key?(:use_routes) end end @@ -2089,7 +2133,7 @@ module Google include Google::Apis::Core::Hashable # Contains the name of the resource requested. - # Specified in the format 'projects/*/locations/*'. + # Specified in the format `projects/*/locations/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2335,16 +2379,17 @@ module Google alias_method :enable_intra_node_visibility?, :enable_intra_node_visibility # Output only. The relative name of the Google Compute Engine - # network(/compute/docs/networks-and-firewalls#networks) to which - # the cluster is connected. - # Example: projects/my-project/global/networks/my-network + # network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) + # to which the cluster is connected. Example: + # projects/my-project/global/networks/my-network # Corresponds to the JSON property `network` # @return [String] attr_accessor :network # Output only. The relative name of the Google Compute Engine - # [subnetwork](/compute/docs/vpc) to which the cluster is connected. - # Example: projects/my-project/regions/us-central1/subnetworks/my-subnet + # [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the + # cluster is connected. Example: + # projects/my-project/regions/us-central1/subnetworks/my-subnet # Corresponds to the JSON property `subnetwork` # @return [String] attr_accessor :subnetwork @@ -2473,7 +2518,7 @@ module Google attr_accessor :local_ssd_count # The name of a Google Compute Engine [machine - # type](/compute/docs/machine-types) (e.g. + # type](https://cloud.google.com/compute/docs/machine-types) (e.g. # `n1-standard-1`). # If unspecified, the default machine type is # `n1-standard-1`. @@ -2534,7 +2579,8 @@ module Google # persistent storage on your nodes. # * `https://www.googleapis.com/auth/devstorage.read_only` is required for # communicating with **gcr.io** - # (the [Google Container Registry](/container-registry/)). + # (the [Google Container + # Registry](https://cloud.google.com/container-registry/)). # If unspecified, no scopes are added, unless Cloud Logging or Cloud # Monitoring are enabled, in which case their required scopes will be added. # Corresponds to the JSON property `oauthScopes` @@ -2549,8 +2595,9 @@ module Google attr_accessor :preemptible alias_method :preemptible?, :preemptible - # [ReservationAffinity](/compute/docs/instances/reserving-zonal-resources) is - # the configuration of desired reservation which instances could take + # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/ + # reserving-zonal-resources) + # is the configuration of desired reservation which instances could take # capacity from. # Corresponds to the JSON property `reservationAffinity` # @return [Google::Apis::ContainerV1beta1::ReservationAffinity] @@ -2691,14 +2738,16 @@ module Google attr_accessor :initial_node_count # [Output only] The resource URLs of the [managed instance - # groups](/compute/docs/instance-groups/creating-groups-of-managed-instances) + # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups- + # of-managed-instances) # associated with this node pool. # Corresponds to the JSON property `instanceGroupUrls` # @return [Array] attr_accessor :instance_group_urls - # The list of Google Compute Engine [zones](/compute/docs/zones#available) - # in which the NodePool's nodes should be located. + # The list of Google Compute Engine + # [zones](https://cloud.google.com/compute/docs/zones#available) in which the + # NodePool's nodes should be located. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations @@ -2889,9 +2938,12 @@ module Google attr_accessor :end_time # [Output only] The name of the Google Compute Engine - # [zone](/compute/docs/regions-zones/regions-zones#available) or - # [region](/compute/docs/regions-zones/regions-zones#available) in which - # the cluster resides. + # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones# + # available) + # or + # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones# + # available) + # in which the cluster resides. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location @@ -2943,9 +2995,8 @@ module Google attr_accessor :target_link # The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the operation - # is taking place. - # This field is deprecated, use location instead. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # operation is taking place. This field is deprecated, use location instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3226,8 +3277,9 @@ module Google end end - # [ReservationAffinity](/compute/docs/instances/reserving-zonal-resources) is - # the configuration of desired reservation which instances could take + # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/ + # reserving-zonal-resources) + # is the configuration of desired reservation which instances could take # capacity from. class ReservationAffinity include Google::Apis::Core::Hashable @@ -3340,7 +3392,7 @@ module Google # The name (project, location, cluster, node pool id) of the node poll to # rollback upgrade. - # Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'. + # Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3359,9 +3411,9 @@ module Google attr_accessor :project_id # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3471,7 +3523,7 @@ module Google attr_accessor :cluster_id # The name (project, location, cluster) of the cluster to set addons. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3484,9 +3536,9 @@ module Google attr_accessor :project_id # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3528,7 +3580,7 @@ module Google attr_accessor :label_fingerprint # The name (project, location, cluster id) of the cluster to set labels. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3546,9 +3598,9 @@ module Google attr_accessor :resource_labels # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3586,7 +3638,7 @@ module Google alias_method :enabled?, :enabled # The name (project, location, cluster id) of the cluster to set legacy abac. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3599,9 +3651,9 @@ module Google attr_accessor :project_id # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3631,17 +3683,17 @@ module Google attr_accessor :cluster_id # Required. The desired list of Google Compute Engine - # [zones](/compute/docs/zones#available) in which the cluster's nodes - # should be located. Changing the locations a cluster is in will result - # in nodes being either created or removed from the cluster, depending on - # whether locations are being added or removed. + # [zones](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster's nodes should be located. Changing the locations a cluster is in + # will result in nodes being either created or removed from the cluster, + # depending on whether locations are being added or removed. # This list must always include the cluster's primary zone. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations # The name (project, location, cluster) of the cluster to set locations. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3654,9 +3706,9 @@ module Google attr_accessor :project_id # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3699,7 +3751,7 @@ module Google attr_accessor :logging_service # The name (project, location, cluster) of the cluster to set logging. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3712,9 +3764,9 @@ module Google attr_accessor :project_id # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3749,7 +3801,7 @@ module Google # The name (project, location, cluster id) of the cluster to set maintenance # policy. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3761,8 +3813,8 @@ module Google attr_accessor :project_id # Required. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3797,7 +3849,7 @@ module Google attr_accessor :cluster_id # The name (project, location, cluster) of the cluster to set auth. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3817,9 +3869,9 @@ module Google attr_accessor :update # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3863,7 +3915,7 @@ module Google attr_accessor :monitoring_service # The name (project, location, cluster) of the cluster to set monitoring. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3876,9 +3928,9 @@ module Google attr_accessor :project_id # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3908,7 +3960,7 @@ module Google attr_accessor :cluster_id # The name (project, location, cluster id) of the cluster to set networking - # policy. Specified in the format 'projects/*/locations/*/clusters/*'. + # policy. Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3927,9 +3979,9 @@ module Google attr_accessor :project_id # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3966,7 +4018,7 @@ module Google # The name (project, location, cluster, node pool) of the node pool to set # autoscaler settings. Specified in the format - # 'projects/*/locations/*/clusters/*/nodePools/*'. + # `projects/*/locations/*/clusters/*/nodePools/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3985,9 +4037,9 @@ module Google attr_accessor :project_id # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -4026,7 +4078,7 @@ module Google # The name (project, location, cluster, node pool id) of the node pool to set # management properties. Specified in the format - # 'projects/*/locations/*/clusters/*/nodePools/*'. + # `projects/*/locations/*/clusters/*/nodePools/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4045,9 +4097,9 @@ module Google attr_accessor :project_id # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -4080,7 +4132,7 @@ module Google # The name (project, location, cluster, node pool id) of the node pool to set # size. - # Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'. + # Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4104,9 +4156,9 @@ module Google attr_accessor :project_id # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -4192,7 +4244,7 @@ module Google attr_accessor :cluster_id # The name (project, location, cluster id) of the cluster to start IP - # rotation. Specified in the format 'projects/*/locations/*/clusters/*'. + # rotation. Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4211,9 +4263,9 @@ module Google alias_method :rotate_credentials?, :rotate_credentials # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -4328,7 +4380,7 @@ module Google attr_accessor :cluster_id # The name (project, location, cluster) of the cluster to update. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4348,9 +4400,9 @@ module Google attr_accessor :update # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -4392,7 +4444,7 @@ module Google attr_accessor :master_version # The name (project, location, cluster) of the cluster to update. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4405,9 +4457,9 @@ module Google attr_accessor :project_id # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -4442,17 +4494,17 @@ module Google attr_accessor :image_type # The desired list of Google Compute Engine - # [zones](/compute/docs/zones#available) in which the node pool's nodes - # should be located. Changing the locations for a node pool will result - # in nodes being either created or removed from the node pool, depending - # on whether locations are being added or removed. + # [zones](https://cloud.google.com/compute/docs/zones#available) in which the + # node pool's nodes should be located. Changing the locations for a node pool + # will result in nodes being either created or removed from the node pool, + # depending on whether locations are being added or removed. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations # The name (project, location, cluster, node pool) of the node pool to # update. Specified in the format - # 'projects/*/locations/*/clusters/*/nodePools/*'. + # `projects/*/locations/*/clusters/*/nodePools/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4512,9 +4564,9 @@ module Google attr_accessor :workload_metadata_config # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone diff --git a/generated/google/apis/container_v1beta1/representations.rb b/generated/google/apis/container_v1beta1/representations.rb index ed15d572b..5a88a78d9 100644 --- a/generated/google/apis/container_v1beta1/representations.rb +++ b/generated/google/apis/container_v1beta1/representations.rb @@ -124,6 +124,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ConfigConnectorConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ConsumptionMeteringConfig class Representation < Google::Apis::Core::JsonRepresentation; end @@ -623,6 +629,8 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :cloud_run_config, as: 'cloudRunConfig', class: Google::Apis::ContainerV1beta1::CloudRunConfig, decorator: Google::Apis::ContainerV1beta1::CloudRunConfig::Representation + property :config_connector_config, as: 'configConnectorConfig', class: Google::Apis::ContainerV1beta1::ConfigConnectorConfig, decorator: Google::Apis::ContainerV1beta1::ConfigConnectorConfig::Representation + property :dns_cache_config, as: 'dnsCacheConfig', class: Google::Apis::ContainerV1beta1::DnsCacheConfig, decorator: Google::Apis::ContainerV1beta1::DnsCacheConfig::Representation property :gce_persistent_disk_csi_driver_config, as: 'gcePersistentDiskCsiDriverConfig', class: Google::Apis::ContainerV1beta1::GcePersistentDiskCsiDriverConfig, decorator: Google::Apis::ContainerV1beta1::GcePersistentDiskCsiDriverConfig::Representation @@ -887,6 +895,13 @@ module Google end end + class ConfigConnectorConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :enabled, as: 'enabled' + end + end + class ConsumptionMeteringConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1017,6 +1032,7 @@ module Google property :subnetwork_name, as: 'subnetworkName' property :tpu_ipv4_cidr_block, as: 'tpuIpv4CidrBlock' property :use_ip_aliases, as: 'useIpAliases' + property :use_routes, as: 'useRoutes' end end diff --git a/generated/google/apis/container_v1beta1/service.rb b/generated/google/apis/container_v1beta1/service.rb index 05164a4a7..191dfbe3d 100644 --- a/generated/google/apis/container_v1beta1/service.rb +++ b/generated/google/apis/container_v1beta1/service.rb @@ -51,7 +51,7 @@ module Google # Lists subnetworks that can be used for creating clusters in a project. # @param [String] parent # Required. The parent project where subnetworks are usable. - # Specified in the format 'projects/*'. + # Specified in the format `projects/*`. # @param [String] filter # Filtering currently only supports equality on the networkProjectId and must # be in the form: "networkProjectId=[PROJECTID]", where `networkProjectId` @@ -98,15 +98,16 @@ module Google # Returns configuration info about the Google Kubernetes Engine service. # @param [String] name # The name (project and location) of the server config to get, - # specified in the format 'projects/*/locations/*'. + # specified in the format `projects/*/locations/*`. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) to return operations for. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) to return + # operations for. This field has been deprecated and replaced by the name + # field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -139,7 +140,7 @@ module Google # Fetches locations that offer Google Kubernetes Engine. # @param [String] parent # Required. Contains the name of the resource requested. - # Specified in the format 'projects/*'. + # Specified in the format `projects/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -170,7 +171,7 @@ module Google # Completes master IP rotation. # @param [String] name # The name (project, location, cluster id) of the cluster to complete IP - # rotation. Specified in the format 'projects/*/locations/*/clusters/*'. + # rotation. Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1beta1::CompleteIpRotationRequest] complete_ip_rotation_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -204,7 +205,9 @@ module Google # Creates a cluster, consisting of the specified number and type of Google # Compute Engine instances. # By default, the cluster is created in the project's - # [default network](/compute/docs/networks-and-firewalls#networks). + # [default + # network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) + # . # One firewall is added for the cluster. After cluster creation, # the Kubelet creates routes for each node to allow the containers # on that node to communicate with all other instances in the @@ -213,7 +216,7 @@ module Google # which CIDR range the cluster is using. # @param [String] parent # The parent (project and location) where the cluster will be created. - # Specified in the format 'projects/*/locations/*'. + # Specified in the format `projects/*/locations/*`. # @param [Google::Apis::ContainerV1beta1::CreateClusterRequest] create_cluster_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -253,7 +256,7 @@ module Google # when the cluster was initially created. # @param [String] name # The name (project, location, cluster) of the cluster to delete. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [String] cluster_id # Required. Deprecated. The name of the cluster to delete. # This field has been deprecated and replaced by the name field. @@ -263,9 +266,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -299,7 +302,7 @@ module Google # Gets the details for a specific cluster. # @param [String] name # The name (project, location, cluster) of the cluster to retrieve. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [String] cluster_id # Required. Deprecated. The name of the cluster to retrieve. # This field has been deprecated and replaced by the name field. @@ -309,9 +312,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -348,7 +351,7 @@ module Google # clusters. # @param [String] parent # The cluster (project, location, cluster id) to get keys for. Specified in - # the format 'projects/*/locations/*/clusters/*'. + # the format `projects/*/locations/*/clusters/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -380,7 +383,7 @@ module Google # zones. # @param [String] parent # The parent (project and location) where the clusters will be listed. - # Specified in the format 'projects/*/locations/*'. + # Specified in the format `projects/*/locations/*`. # Location "-" matches all zones and all regions. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project @@ -388,9 +391,9 @@ module Google # This field has been deprecated and replaced by the parent field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides, or "-" for all zones. - # This field has been deprecated and replaced by the parent field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides, or "-" for all zones. This field has been deprecated and + # replaced by the parent field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -423,7 +426,7 @@ module Google # Sets the addons for a specific cluster. # @param [String] name # The name (project, location, cluster) of the cluster to set addons. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1beta1::SetAddonsConfigRequest] set_addons_config_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -457,7 +460,7 @@ module Google # Enables or disables the ABAC authorization mechanism on a cluster. # @param [String] name # The name (project, location, cluster id) of the cluster to set legacy abac. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1beta1::SetLegacyAbacRequest] set_legacy_abac_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -490,12 +493,12 @@ module Google # Sets the locations for a specific cluster. # Deprecated. Use - # [projects.locations.clusters.update](/kubernetes-engine/docs/reference/rest/ - # v1beta1/projects.locations.clusters/update) + # [projects.locations.clusters.update](https://cloud.google.com/kubernetes- + # engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) # instead. # @param [String] name # The name (project, location, cluster) of the cluster to set locations. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1beta1::SetLocationsRequest] set_locations_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -529,7 +532,7 @@ module Google # Sets the logging service for a specific cluster. # @param [String] name # The name (project, location, cluster) of the cluster to set logging. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1beta1::SetLoggingServiceRequest] set_logging_service_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -564,7 +567,7 @@ module Google # @param [String] name # The name (project, location, cluster id) of the cluster to set maintenance # policy. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1beta1::SetMaintenancePolicyRequest] set_maintenance_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -600,7 +603,7 @@ module Google # the password. # @param [String] name # The name (project, location, cluster) of the cluster to set auth. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1beta1::SetMasterAuthRequest] set_master_auth_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -634,7 +637,7 @@ module Google # Sets the monitoring service for a specific cluster. # @param [String] name # The name (project, location, cluster) of the cluster to set monitoring. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1beta1::SetMonitoringServiceRequest] set_monitoring_service_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -668,7 +671,7 @@ module Google # Enables or disables Network Policy for a cluster. # @param [String] name # The name (project, location, cluster id) of the cluster to set networking - # policy. Specified in the format 'projects/*/locations/*/clusters/*'. + # policy. Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1beta1::SetNetworkPolicyRequest] set_network_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -702,7 +705,7 @@ module Google # Sets labels on a cluster. # @param [String] name # The name (project, location, cluster id) of the cluster to set labels. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1beta1::SetLabelsRequest] set_labels_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -736,7 +739,7 @@ module Google # Starts master IP rotation. # @param [String] name # The name (project, location, cluster id) of the cluster to start IP - # rotation. Specified in the format 'projects/*/locations/*/clusters/*'. + # rotation. Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1beta1::StartIpRotationRequest] start_ip_rotation_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -770,7 +773,7 @@ module Google # Updates the settings for a specific cluster. # @param [String] name # The name (project, location, cluster) of the cluster to update. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1beta1::UpdateClusterRequest] update_cluster_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -804,7 +807,7 @@ module Google # Updates the master for a specific cluster. # @param [String] name # The name (project, location, cluster) of the cluster to update. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1beta1::UpdateMasterRequest] update_master_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -839,7 +842,7 @@ module Google # @param [String] parent # The parent (project, location, cluster id) where the node pool will be # created. Specified in the format - # 'projects/*/locations/*/clusters/*'. + # `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1beta1::CreateNodePoolRequest] create_node_pool_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -874,7 +877,7 @@ module Google # @param [String] name # The name (project, location, cluster, node pool id) of the node pool to # delete. Specified in the format - # 'projects/*/locations/*/clusters/*/nodePools/*'. + # `projects/*/locations/*/clusters/*/nodePools/*`. # @param [String] cluster_id # Required. Deprecated. The name of the cluster. # This field has been deprecated and replaced by the name field. @@ -887,9 +890,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -925,7 +928,7 @@ module Google # @param [String] name # The name (project, location, cluster, node pool id) of the node pool to # get. Specified in the format - # 'projects/*/locations/*/clusters/*/nodePools/*'. + # `projects/*/locations/*/clusters/*/nodePools/*`. # @param [String] cluster_id # Required. Deprecated. The name of the cluster. # This field has been deprecated and replaced by the name field. @@ -938,9 +941,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -975,7 +978,7 @@ module Google # Lists the node pools for a cluster. # @param [String] parent # The parent (project, location, cluster id) where the node pools will be - # listed. Specified in the format 'projects/*/locations/*/clusters/*'. + # listed. Specified in the format `projects/*/locations/*/clusters/*`. # @param [String] cluster_id # Required. Deprecated. The name of the cluster. # This field has been deprecated and replaced by the parent field. @@ -985,9 +988,9 @@ module Google # This field has been deprecated and replaced by the parent field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the parent field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the parent + # field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1023,7 +1026,7 @@ module Google # @param [String] name # The name (project, location, cluster, node pool id) of the node poll to # rollback upgrade. - # Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'. + # Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. # @param [Google::Apis::ContainerV1beta1::RollbackNodePoolUpgradeRequest] rollback_node_pool_upgrade_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1058,7 +1061,7 @@ module Google # @param [String] name # The name (project, location, cluster, node pool) of the node pool to set # autoscaler settings. Specified in the format - # 'projects/*/locations/*/clusters/*/nodePools/*'. + # `projects/*/locations/*/clusters/*/nodePools/*`. # @param [Google::Apis::ContainerV1beta1::SetNodePoolAutoscalingRequest] set_node_pool_autoscaling_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1093,7 +1096,7 @@ module Google # @param [String] name # The name (project, location, cluster, node pool id) of the node pool to set # management properties. Specified in the format - # 'projects/*/locations/*/clusters/*/nodePools/*'. + # `projects/*/locations/*/clusters/*/nodePools/*`. # @param [Google::Apis::ContainerV1beta1::SetNodePoolManagementRequest] set_node_pool_management_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1128,7 +1131,7 @@ module Google # @param [String] name # The name (project, location, cluster, node pool id) of the node pool to set # size. - # Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'. + # Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. # @param [Google::Apis::ContainerV1beta1::SetNodePoolSizeRequest] set_node_pool_size_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1163,7 +1166,7 @@ module Google # @param [String] name # The name (project, location, cluster, node pool) of the node pool to # update. Specified in the format - # 'projects/*/locations/*/clusters/*/nodePools/*'. + # `projects/*/locations/*/clusters/*/nodePools/*`. # @param [Google::Apis::ContainerV1beta1::UpdateNodePoolRequest] update_node_pool_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1203,7 +1206,7 @@ module Google # clusters. # @param [String] parent # The cluster (project, location, cluster id) to get the discovery document - # for. Specified in the format 'projects/*/locations/*/clusters/*'. + # for. Specified in the format `projects/*/locations/*/clusters/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1234,7 +1237,7 @@ module Google # Cancels the specified operation. # @param [String] name # The name (project, location, operation id) of the operation to cancel. - # Specified in the format 'projects/*/locations/*/operations/*'. + # Specified in the format `projects/*/locations/*/operations/*`. # @param [Google::Apis::ContainerV1beta1::CancelOperationRequest] cancel_operation_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1268,7 +1271,7 @@ module Google # Gets the specified operation. # @param [String] name # The name (project, location, operation id) of the operation to get. - # Specified in the format 'projects/*/locations/*/operations/*'. + # Specified in the format `projects/*/locations/*/operations/*`. # @param [String] operation_id # Required. Deprecated. The server-assigned `name` of the operation. # This field has been deprecated and replaced by the name field. @@ -1278,9 +1281,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1314,7 +1317,7 @@ module Google # Lists all operations in a project in the specified zone or all zones. # @param [String] parent # The parent (project and location) where the operations will be listed. - # Specified in the format 'projects/*/locations/*'. + # Specified in the format `projects/*/locations/*`. # Location "-" matches all zones and all regions. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project @@ -1322,8 +1325,9 @@ module Google # This field has been deprecated and replaced by the parent field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) to return operations for, or `-` for - # all zones. This field has been deprecated and replaced by the parent field. + # [zone](https://cloud.google.com/compute/docs/zones#available) to return + # operations for, or `-` for all zones. This field has been deprecated and + # replaced by the parent field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1360,11 +1364,12 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) to return operations for. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) to return + # operations for. This field has been deprecated and replaced by the name + # field. # @param [String] name # The name (project and location) of the server config to get, - # specified in the format 'projects/*/locations/*'. + # specified in the format `projects/*/locations/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1401,9 +1406,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Required. Deprecated. The name of the cluster to upgrade. # This field has been deprecated and replaced by the name field. @@ -1446,9 +1451,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Required. Deprecated. The name of the cluster. # This field has been deprecated and replaced by the name field. @@ -1487,7 +1492,9 @@ module Google # Creates a cluster, consisting of the specified number and type of Google # Compute Engine instances. # By default, the cluster is created in the project's - # [default network](/compute/docs/networks-and-firewalls#networks). + # [default + # network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) + # . # One firewall is added for the cluster. After cluster creation, # the Kubelet creates routes for each node to allow the containers # on that node to communicate with all other instances in the @@ -1500,9 +1507,9 @@ module Google # This field has been deprecated and replaced by the parent field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the parent field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the parent + # field. # @param [Google::Apis::ContainerV1beta1::CreateClusterRequest] create_cluster_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1547,15 +1554,15 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Required. Deprecated. The name of the cluster to delete. # This field has been deprecated and replaced by the name field. # @param [String] name # The name (project, location, cluster) of the cluster to delete. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1593,15 +1600,15 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Required. Deprecated. The name of the cluster to retrieve. # This field has been deprecated and replaced by the name field. # @param [String] name # The name (project, location, cluster) of the cluster to retrieve. - # Specified in the format 'projects/*/locations/*/clusters/*'. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1639,9 +1646,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Required. Deprecated. The name of the cluster to update. # This field has been deprecated and replaced by the name field. @@ -1685,12 +1692,12 @@ module Google # This field has been deprecated and replaced by the parent field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides, or "-" for all zones. - # This field has been deprecated and replaced by the parent field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides, or "-" for all zones. This field has been deprecated and + # replaced by the parent field. # @param [String] parent # The parent (project and location) where the clusters will be listed. - # Specified in the format 'projects/*/locations/*'. + # Specified in the format `projects/*/locations/*`. # Location "-" matches all zones and all regions. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1723,8 +1730,8 @@ module Google # Sets the locations for a specific cluster. # Deprecated. Use - # [projects.locations.clusters.update](/kubernetes-engine/docs/reference/rest/ - # v1beta1/projects.locations.clusters/update) + # [projects.locations.clusters.update](https://cloud.google.com/kubernetes- + # engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) # instead. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project @@ -1732,9 +1739,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Required. Deprecated. The name of the cluster to upgrade. # This field has been deprecated and replaced by the name field. @@ -1777,9 +1784,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Required. Deprecated. The name of the cluster to upgrade. # This field has been deprecated and replaced by the name field. @@ -1822,9 +1829,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Required. Deprecated. The name of the cluster to upgrade. # This field has been deprecated and replaced by the name field. @@ -1867,9 +1874,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Required. Deprecated. The name of the cluster to upgrade. # This field has been deprecated and replaced by the name field. @@ -1912,9 +1919,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Required. Deprecated. The name of the cluster. # This field has been deprecated and replaced by the name field. @@ -1956,8 +1963,8 @@ module Google # number](https://support.google.com/cloud/answer/6158840). # @param [String] zone # Required. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. # @param [String] cluster_id # Required. The name of the cluster to update. # @param [Google::Apis::ContainerV1beta1::SetMaintenancePolicyRequest] set_maintenance_policy_request_object @@ -2001,9 +2008,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Required. Deprecated. The name of the cluster to upgrade. # This field has been deprecated and replaced by the name field. @@ -2046,9 +2053,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Required. Deprecated. The name of the cluster. # This field has been deprecated and replaced by the name field. @@ -2091,9 +2098,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Required. Deprecated. The name of the cluster. # This field has been deprecated and replaced by the name field. @@ -2136,9 +2143,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Required. Deprecated. The name of the cluster to upgrade. # This field has been deprecated and replaced by the name field. @@ -2181,9 +2188,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Required. Deprecated. The name of the cluster to upgrade. # This field has been deprecated and replaced by the name field. @@ -2230,9 +2237,9 @@ module Google # This field has been deprecated and replaced by the parent field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the parent field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the parent + # field. # @param [String] cluster_id # Required. Deprecated. The name of the cluster. # This field has been deprecated and replaced by the parent field. @@ -2275,9 +2282,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Required. Deprecated. The name of the cluster. # This field has been deprecated and replaced by the name field. @@ -2287,7 +2294,7 @@ module Google # @param [String] name # The name (project, location, cluster, node pool id) of the node pool to # delete. Specified in the format - # 'projects/*/locations/*/clusters/*/nodePools/*'. + # `projects/*/locations/*/clusters/*/nodePools/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2326,9 +2333,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Required. Deprecated. The name of the cluster. # This field has been deprecated and replaced by the name field. @@ -2338,7 +2345,7 @@ module Google # @param [String] name # The name (project, location, cluster, node pool id) of the node pool to # get. Specified in the format - # 'projects/*/locations/*/clusters/*/nodePools/*'. + # `projects/*/locations/*/clusters/*/nodePools/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2377,15 +2384,15 @@ module Google # This field has been deprecated and replaced by the parent field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the parent field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the parent + # field. # @param [String] cluster_id # Required. Deprecated. The name of the cluster. # This field has been deprecated and replaced by the parent field. # @param [String] parent # The parent (project, location, cluster id) where the node pools will be - # listed. Specified in the format 'projects/*/locations/*/clusters/*'. + # listed. Specified in the format `projects/*/locations/*/clusters/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2424,9 +2431,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Required. Deprecated. The name of the cluster to rollback. # This field has been deprecated and replaced by the name field. @@ -2473,9 +2480,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Required. Deprecated. The name of the cluster to update. # This field has been deprecated and replaced by the name field. @@ -2522,9 +2529,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Required. Deprecated. The name of the cluster to update. # This field has been deprecated and replaced by the name field. @@ -2571,9 +2578,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] cluster_id # Required. Deprecated. The name of the cluster to upgrade. # This field has been deprecated and replaced by the name field. @@ -2620,8 +2627,9 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the operation resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # operation resides. This field has been deprecated and replaced by the name + # field. # @param [String] operation_id # Required. Deprecated. The server-assigned `name` of the operation. # This field has been deprecated and replaced by the name field. @@ -2664,15 +2672,15 @@ module Google # This field has been deprecated and replaced by the name field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) in which the cluster - # resides. - # This field has been deprecated and replaced by the name field. + # [zone](https://cloud.google.com/compute/docs/zones#available) in which the + # cluster resides. This field has been deprecated and replaced by the name + # field. # @param [String] operation_id # Required. Deprecated. The server-assigned `name` of the operation. # This field has been deprecated and replaced by the name field. # @param [String] name # The name (project, location, operation id) of the operation to get. - # Specified in the format 'projects/*/locations/*/operations/*'. + # Specified in the format `projects/*/locations/*/operations/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2710,11 +2718,12 @@ module Google # This field has been deprecated and replaced by the parent field. # @param [String] zone # Required. Deprecated. The name of the Google Compute Engine - # [zone](/compute/docs/zones#available) to return operations for, or `-` for - # all zones. This field has been deprecated and replaced by the parent field. + # [zone](https://cloud.google.com/compute/docs/zones#available) to return + # operations for, or `-` for all zones. This field has been deprecated and + # replaced by the parent field. # @param [String] parent # The parent (project and location) where the operations will be listed. - # Specified in the format 'projects/*/locations/*'. + # Specified in the format `projects/*/locations/*`. # Location "-" matches all zones and all regions. # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/containeranalysis_v1alpha1.rb b/generated/google/apis/containeranalysis_v1alpha1.rb index e914b4bbc..4bb1a1b42 100644 --- a/generated/google/apis/containeranalysis_v1alpha1.rb +++ b/generated/google/apis/containeranalysis_v1alpha1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/container-analysis/api/reference/rest/ module ContaineranalysisV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200221' + REVISION = '20200501' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/containeranalysis_v1alpha1/classes.rb b/generated/google/apis/containeranalysis_v1alpha1/classes.rb index a611af88e..2039a4600 100644 --- a/generated/google/apis/containeranalysis_v1alpha1/classes.rb +++ b/generated/google/apis/containeranalysis_v1alpha1/classes.rb @@ -1051,6 +1051,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value 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 `requestedPolicyVersion` # @return [Fixnum] attr_accessor :requested_policy_version @@ -1995,10 +1998,13 @@ module Google # 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. - # Optionally, a `binding` can 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. + # 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": [ @@ -2013,7 +2019,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -2086,6 +2094,9 @@ module Google # 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 @@ -2259,10 +2270,13 @@ module Google # 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. - # Optionally, a `binding` can 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. + # 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": [ @@ -2277,7 +2291,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", diff --git a/generated/google/apis/containeranalysis_v1beta1.rb b/generated/google/apis/containeranalysis_v1beta1.rb index 3cc360c45..b90394608 100644 --- a/generated/google/apis/containeranalysis_v1beta1.rb +++ b/generated/google/apis/containeranalysis_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/container-analysis/api/reference/rest/ module ContaineranalysisV1beta1 VERSION = 'V1beta1' - REVISION = '20200221' + REVISION = '20200501' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/containeranalysis_v1beta1/classes.rb b/generated/google/apis/containeranalysis_v1beta1/classes.rb index 0e7deecf9..1a96b3219 100644 --- a/generated/google/apis/containeranalysis_v1beta1/classes.rb +++ b/generated/google/apis/containeranalysis_v1beta1/classes.rb @@ -84,6 +84,44 @@ module Google end end + # Defines a hash object for use in Materials and Products. + class ArtifactHashes + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `sha256` + # @return [String] + attr_accessor :sha256 + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @sha256 = args[:sha256] if args.key?(:sha256) + end + end + + # Defines an object to declare an in-toto artifact rule + class ArtifactRule + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `artifactRule` + # @return [Array] + attr_accessor :artifact_rule + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @artifact_rule = args[:artifact_rule] if args.key?(:artifact_rule) + end + end + # Occurrence that represents a single "attestation". The authenticity of an # attestation can be verified using the attached signature. If the verifier # trusts the public key of the signer, then verifying the signature is @@ -516,6 +554,26 @@ module Google end end + # Defines an object for the byproducts field in in-toto links. The suggested + # fields are "stderr", "stdout", and "return-value". + class ByProducts + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `customValues` + # @return [Hash] + attr_accessor :custom_values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @custom_values = args[:custom_values] if args.key?(:custom_values) + end + end + # Common Vulnerability Scoring System version 3. # For details, see https://www.first.org/cvss/specification-document class CvsSv3 @@ -1045,6 +1103,26 @@ module Google end end + # Defines an object for the environment field in in-toto links. The suggested + # fields are "variables", "filesystem", and "workdir". + class Environment + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `customValues` + # @return [Hash] + attr_accessor :custom_values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @custom_values = args[:custom_values] if args.key?(:custom_values) + 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. @@ -1311,6 +1389,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value 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 `requestedPolicyVersion` # @return [Fixnum] attr_accessor :requested_policy_version @@ -1471,6 +1552,83 @@ module Google end end + # + class GrafeasV1beta1IntotoArtifact + include Google::Apis::Core::Hashable + + # Defines a hash object for use in Materials and Products. + # Corresponds to the JSON property `hashes` + # @return [Google::Apis::ContaineranalysisV1beta1::ArtifactHashes] + attr_accessor :hashes + + # + # Corresponds to the JSON property `resourceUri` + # @return [String] + attr_accessor :resource_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @hashes = args[:hashes] if args.key?(:hashes) + @resource_uri = args[:resource_uri] if args.key?(:resource_uri) + end + end + + # This corresponds to a signed in-toto link - it is made up of one or more + # signatures and the in-toto link itself. This is used for occurrences of a + # Grafeas in-toto note. + class GrafeasV1beta1IntotoDetails + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `signatures` + # @return [Array] + attr_accessor :signatures + + # This corresponds to an in-toto link. + # Corresponds to the JSON property `signed` + # @return [Google::Apis::ContaineranalysisV1beta1::Link] + attr_accessor :signed + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @signatures = args[:signatures] if args.key?(:signatures) + @signed = args[:signed] if args.key?(:signed) + end + end + + # A signature object consists of the KeyID used and the signature itself. + class GrafeasV1beta1IntotoSignature + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `keyid` + # @return [String] + attr_accessor :keyid + + # + # Corresponds to the JSON property `sig` + # @return [String] + attr_accessor :sig + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @keyid = args[:keyid] if args.key?(:keyid) + @sig = args[:sig] if args.key?(:sig) + end + end + # Details of a package occurrence. class GrafeasV1beta1PackageDetails include Google::Apis::Core::Hashable @@ -1610,6 +1768,60 @@ module Google end end + # This contains the fields corresponding to the definition of a software supply + # chain step in an in-toto layout. This information goes into a Grafeas note. + class InToto + include Google::Apis::Core::Hashable + + # This field contains the expected command used to perform the step. + # Corresponds to the JSON property `expectedCommand` + # @return [Array] + attr_accessor :expected_command + + # The following fields contain in-toto artifact rules identifying the + # artifacts that enter this supply chain step, and exit the supply chain + # step, i.e. materials and products of the step. + # Corresponds to the JSON property `expectedMaterials` + # @return [Array] + attr_accessor :expected_materials + + # + # Corresponds to the JSON property `expectedProducts` + # @return [Array] + attr_accessor :expected_products + + # This field contains the public keys that can be used to verify the + # signatures on the step metadata. + # Corresponds to the JSON property `signingKeys` + # @return [Array] + attr_accessor :signing_keys + + # This field identifies the name of the step in the supply chain. + # Corresponds to the JSON property `stepName` + # @return [String] + attr_accessor :step_name + + # This field contains a value that indicates the minimum number of keys that + # need to be used to sign the step's in-toto link. + # Corresponds to the JSON property `threshold` + # @return [Fixnum] + attr_accessor :threshold + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @expected_command = args[:expected_command] if args.key?(:expected_command) + @expected_materials = args[:expected_materials] if args.key?(:expected_materials) + @expected_products = args[:expected_products] if args.key?(:expected_products) + @signing_keys = args[:signing_keys] if args.key?(:signing_keys) + @step_name = args[:step_name] if args.key?(:step_name) + @threshold = args[:threshold] if args.key?(:threshold) + end + end + # This represents how a particular software package may be installed on a # system. class Installation @@ -1688,6 +1900,67 @@ module Google end end + # This corresponds to an in-toto link. + class Link + include Google::Apis::Core::Hashable + + # Defines an object for the byproducts field in in-toto links. The suggested + # fields are "stderr", "stdout", and "return-value". + # Corresponds to the JSON property `byproducts` + # @return [Google::Apis::ContaineranalysisV1beta1::ByProducts] + attr_accessor :byproducts + + # This field contains the full command executed for the step. This can also + # be empty if links are generated for operations that aren't directly mapped + # to a specific command. Each term in the command is an independent string + # in the list. An example of a command in the in-toto metadata field is: + # "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"] + # Corresponds to the JSON property `command` + # @return [Array] + attr_accessor :command + + # Defines an object for the environment field in in-toto links. The suggested + # fields are "variables", "filesystem", and "workdir". + # Corresponds to the JSON property `environment` + # @return [Google::Apis::ContaineranalysisV1beta1::Environment] + attr_accessor :environment + + # Materials are the supply chain artifacts that go into the step and are used + # for the operation performed. The key of the map is the path of the artifact + # and the structure contains the recorded hash information. An example is: + # "materials": [ + # ` + # "resource_uri": "foo/bar", + # "hashes": ` + # "sha256": "ebebf...", + # : + # ` + # ` + # ] + # Corresponds to the JSON property `materials` + # @return [Array] + attr_accessor :materials + + # Products are the supply chain artifacts generated as a result of the step. + # The structure is identical to that of materials. + # Corresponds to the JSON property `products` + # @return [Array] + attr_accessor :products + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @byproducts = args[:byproducts] if args.key?(:byproducts) + @command = args[:command] if args.key?(:command) + @environment = args[:environment] if args.key?(:environment) + @materials = args[:materials] if args.key?(:materials) + @products = args[:products] if args.key?(:products) + end + end + # Response for listing occurrences for a note. class ListNoteOccurrencesResponse include Google::Apis::Core::Hashable @@ -1881,6 +2154,12 @@ module Google # @return [String] attr_accessor :expiration_time + # This contains the fields corresponding to the definition of a software supply + # chain step in an in-toto layout. This information goes into a Grafeas note. + # Corresponds to the JSON property `intoto` + # @return [Google::Apis::ContaineranalysisV1beta1::InToto] + attr_accessor :intoto + # Output only. The type of analysis. This field can be used as a filter in # list requests. # Corresponds to the JSON property `kind` @@ -1944,6 +2223,7 @@ module Google @deployable = args[:deployable] if args.key?(:deployable) @discovery = args[:discovery] if args.key?(:discovery) @expiration_time = args[:expiration_time] if args.key?(:expiration_time) + @intoto = args[:intoto] if args.key?(:intoto) @kind = args[:kind] if args.key?(:kind) @long_description = args[:long_description] if args.key?(:long_description) @name = args[:name] if args.key?(:name) @@ -1995,6 +2275,13 @@ module Google # @return [Google::Apis::ContaineranalysisV1beta1::GrafeasV1beta1PackageDetails] attr_accessor :installation + # This corresponds to a signed in-toto link - it is made up of one or more + # signatures and the in-toto link itself. This is used for occurrences of a + # Grafeas in-toto note. + # Corresponds to the JSON property `intoto` + # @return [Google::Apis::ContaineranalysisV1beta1::GrafeasV1beta1IntotoDetails] + attr_accessor :intoto + # Output only. This explicitly denotes which of the occurrence details are # specified. This field can be used as a filter in list requests. # Corresponds to the JSON property `kind` @@ -2047,6 +2334,7 @@ module Google @derived_image = args[:derived_image] if args.key?(:derived_image) @discovered = args[:discovered] if args.key?(:discovered) @installation = args[:installation] if args.key?(:installation) + @intoto = args[:intoto] if args.key?(:intoto) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @note_name = args[:note_name] if args.key?(:note_name) @@ -2183,10 +2471,13 @@ module Google # 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. - # Optionally, a `binding` can 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. + # 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": [ @@ -2201,7 +2492,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -2274,6 +2567,9 @@ module Google # 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 @@ -2460,10 +2756,13 @@ module Google # 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. - # Optionally, a `binding` can 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. + # 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": [ @@ -2478,7 +2777,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -2587,6 +2888,55 @@ module Google end end + # This defines the format used to record keys used in the software supply + # chain. An in-toto link is attested using one or more keys defined in the + # in-toto layout. An example of this is: + # ` + # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", + # "key_type": "rsa", + # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", + # "key_scheme": "rsassa-pss-sha256" + # ` + # The format for in-toto's key definition can be found in section 4.2 of the + # in-toto specification. + class SigningKey + include Google::Apis::Core::Hashable + + # key_id is an identifier for the signing key. + # Corresponds to the JSON property `keyId` + # @return [String] + attr_accessor :key_id + + # This field contains the corresponding signature scheme. + # Eg: "rsassa-pss-sha256". + # Corresponds to the JSON property `keyScheme` + # @return [String] + attr_accessor :key_scheme + + # This field identifies the specific signing method. Eg: "rsa", "ed25519", + # and "ecdsa". + # Corresponds to the JSON property `keyType` + # @return [String] + attr_accessor :key_type + + # This field contains the actual public key. + # Corresponds to the JSON property `publicKeyValue` + # @return [String] + attr_accessor :public_key_value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @key_id = args[:key_id] if args.key?(:key_id) + @key_scheme = args[:key_scheme] if args.key?(:key_scheme) + @key_type = args[:key_type] if args.key?(:key_type) + @public_key_value = args[:public_key_value] if args.key?(:public_key_value) + end + end + # Source describes the location of the source used for the build. class Source include Google::Apis::Core::Hashable diff --git a/generated/google/apis/containeranalysis_v1beta1/representations.rb b/generated/google/apis/containeranalysis_v1beta1/representations.rb index 0c1180f99..1e3fb858f 100644 --- a/generated/google/apis/containeranalysis_v1beta1/representations.rb +++ b/generated/google/apis/containeranalysis_v1beta1/representations.rb @@ -34,6 +34,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ArtifactHashes + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ArtifactRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Attestation class Representation < Google::Apis::Core::JsonRepresentation; end @@ -100,6 +112,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ByProducts + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class CvsSv3 class Representation < Google::Apis::Core::JsonRepresentation; end @@ -172,6 +190,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Environment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Expr class Representation < Google::Apis::Core::JsonRepresentation; end @@ -256,6 +280,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GrafeasV1beta1IntotoArtifact + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GrafeasV1beta1IntotoDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GrafeasV1beta1IntotoSignature + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GrafeasV1beta1PackageDetails class Representation < Google::Apis::Core::JsonRepresentation; end @@ -280,6 +322,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class InToto + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Installation class Representation < Google::Apis::Core::JsonRepresentation; end @@ -298,6 +346,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Link + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ListNoteOccurrencesResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -406,6 +460,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class SigningKey + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Source class Representation < Google::Apis::Core::JsonRepresentation; end @@ -483,6 +543,20 @@ module Google end end + class ArtifactHashes + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :sha256, as: 'sha256' + end + end + + class ArtifactRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :artifact_rule, as: 'artifactRule' + end + end + class Attestation # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -593,6 +667,13 @@ module Google end end + class ByProducts + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :custom_values, as: 'customValues' + end + end + class CvsSv3 # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -729,6 +810,13 @@ module Google end end + class Environment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :custom_values, as: 'customValues' + end + end + class Expr # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -852,6 +940,33 @@ module Google end end + class GrafeasV1beta1IntotoArtifact + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :hashes, as: 'hashes', class: Google::Apis::ContaineranalysisV1beta1::ArtifactHashes, decorator: Google::Apis::ContaineranalysisV1beta1::ArtifactHashes::Representation + + property :resource_uri, as: 'resourceUri' + end + end + + class GrafeasV1beta1IntotoDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :signatures, as: 'signatures', class: Google::Apis::ContaineranalysisV1beta1::GrafeasV1beta1IntotoSignature, decorator: Google::Apis::ContaineranalysisV1beta1::GrafeasV1beta1IntotoSignature::Representation + + property :signed, as: 'signed', class: Google::Apis::ContaineranalysisV1beta1::Link, decorator: Google::Apis::ContaineranalysisV1beta1::Link::Representation + + end + end + + class GrafeasV1beta1IntotoSignature + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :keyid, as: 'keyid' + property :sig, as: 'sig' + end + end + class GrafeasV1beta1PackageDetails # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -891,6 +1006,21 @@ module Google end end + class InToto + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :expected_command, as: 'expectedCommand' + collection :expected_materials, as: 'expectedMaterials', class: Google::Apis::ContaineranalysisV1beta1::ArtifactRule, decorator: Google::Apis::ContaineranalysisV1beta1::ArtifactRule::Representation + + collection :expected_products, as: 'expectedProducts', class: Google::Apis::ContaineranalysisV1beta1::ArtifactRule, decorator: Google::Apis::ContaineranalysisV1beta1::ArtifactRule::Representation + + collection :signing_keys, as: 'signingKeys', class: Google::Apis::ContaineranalysisV1beta1::SigningKey, decorator: Google::Apis::ContaineranalysisV1beta1::SigningKey::Representation + + property :step_name, as: 'stepName' + property :threshold, :numeric_string => true, as: 'threshold' + end + end + class Installation # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -916,6 +1046,21 @@ module Google end end + class Link + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :byproducts, as: 'byproducts', class: Google::Apis::ContaineranalysisV1beta1::ByProducts, decorator: Google::Apis::ContaineranalysisV1beta1::ByProducts::Representation + + collection :command, as: 'command' + property :environment, as: 'environment', class: Google::Apis::ContaineranalysisV1beta1::Environment, decorator: Google::Apis::ContaineranalysisV1beta1::Environment::Representation + + collection :materials, as: 'materials', class: Google::Apis::ContaineranalysisV1beta1::GrafeasV1beta1IntotoArtifact, decorator: Google::Apis::ContaineranalysisV1beta1::GrafeasV1beta1IntotoArtifact::Representation + + collection :products, as: 'products', class: Google::Apis::ContaineranalysisV1beta1::GrafeasV1beta1IntotoArtifact, decorator: Google::Apis::ContaineranalysisV1beta1::GrafeasV1beta1IntotoArtifact::Representation + + end + end + class ListNoteOccurrencesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -977,6 +1122,8 @@ module Google property :discovery, as: 'discovery', class: Google::Apis::ContaineranalysisV1beta1::Discovery, decorator: Google::Apis::ContaineranalysisV1beta1::Discovery::Representation property :expiration_time, as: 'expirationTime' + property :intoto, as: 'intoto', class: Google::Apis::ContaineranalysisV1beta1::InToto, decorator: Google::Apis::ContaineranalysisV1beta1::InToto::Representation + property :kind, as: 'kind' property :long_description, as: 'longDescription' property :name, as: 'name' @@ -1008,6 +1155,8 @@ module Google property :installation, as: 'installation', class: Google::Apis::ContaineranalysisV1beta1::GrafeasV1beta1PackageDetails, decorator: Google::Apis::ContaineranalysisV1beta1::GrafeasV1beta1PackageDetails::Representation + property :intoto, as: 'intoto', class: Google::Apis::ContaineranalysisV1beta1::GrafeasV1beta1IntotoDetails, decorator: Google::Apis::ContaineranalysisV1beta1::GrafeasV1beta1IntotoDetails::Representation + property :kind, as: 'kind' property :name, as: 'name' property :note_name, as: 'noteName' @@ -1121,6 +1270,16 @@ module Google end end + class SigningKey + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :key_id, as: 'keyId' + property :key_scheme, as: 'keyScheme' + property :key_type, as: 'keyType' + property :public_key_value, as: 'publicKeyValue' + end + end + class Source # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/content_v2.rb b/generated/google/apis/content_v2.rb index cd18c993d..6c4aac46a 100644 --- a/generated/google/apis/content_v2.rb +++ b/generated/google/apis/content_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/shopping-content module ContentV2 VERSION = 'V2' - REVISION = '20200310' + REVISION = '20200421' # Manage your product listings and accounts for Google Shopping AUTH_CONTENT = 'https://www.googleapis.com/auth/content' diff --git a/generated/google/apis/content_v2/classes.rb b/generated/google/apis/content_v2/classes.rb index da6a5fd77..925ef9905 100644 --- a/generated/google/apis/content_v2/classes.rb +++ b/generated/google/apis/content_v2/classes.rb @@ -35,8 +35,8 @@ module Google alias_method :adult_content?, :adult_content # List of linked AdWords accounts that are active or pending approval. To create - # a new link request, add a new link with status active to the list. It will - # remain in a pending state until approved or rejected either in the AdWords + # a new link request, add a new link with status `active` to the list. It will + # remain in a `pending` state until approved or rejected either in the AdWords # interface or through the AdWords API. To delete an active link, or to cancel # a link request, remove it from the list. # Corresponds to the JSON property `adwordsLinks` @@ -59,8 +59,8 @@ module Google # @return [Fixnum] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string "content# - # account". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # account`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -92,10 +92,10 @@ module Google attr_accessor :website_url # List of linked YouTube channels that are active or pending approval. To create - # a new link request, add a new link with status active to the list. It will - # remain in a pending state until approved or rejected in the YT Creator Studio - # interface. To delete an active link, or to cancel a link request, remove it - # from the list. + # a new link request, add a new link with status `active` to the list. It will + # remain in a `pending` state until approved or rejected in the YT Creator + # Studio interface. To delete an active link, or to cancel a link request, + # remove it from the list. # Corresponds to the JSON property `youtubeChannelLinks` # @return [Array] attr_accessor :youtube_channel_links @@ -177,16 +177,16 @@ module Google # Status of the link between this Merchant Center account and the AdWords # account. Upon retrieval, it represents the actual status of the link and can - # be either active if it was approved in Google AdWords or pending if it's + # be either `active` if it was approved in Google AdWords or `pending` if it's # pending approval. Upon insertion, it represents the intended status of the - # link. Re-uploading a link with status active when it's still pending or with - # status pending when it's already active will have no effect: the status will - # remain unchanged. Re-uploading a link with deprecated status inactive is + # link. Re-uploading a link with status `active` when it's still pending or with + # status `pending` when it's already active will have no effect: the status will + # remain unchanged. Re-uploading a link with deprecated status `inactive` is # equivalent to not submitting the link at all and will delete the link if it # was active or cancel the link request if it was pending. # Acceptable values are: - # - "active" - # - "pending" + # - "`active`" + # - "`pending`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -277,8 +277,8 @@ module Google # Status of the link between this Merchant Center account and the GMB account. # Acceptable values are: - # - "active" - # - "pending" + # - "`active`" + # - "`pending`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -340,8 +340,8 @@ module Google # @return [Array] attr_accessor :data_quality_issues - # Identifies what kind of resource this is. Value: the fixed string "content# - # accountStatus". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # accountStatus`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -404,9 +404,9 @@ module Google # Severity of the issue. # Acceptable values are: - # - "critical" - # - "error" - # - "suggestion" + # - "`critical`" + # - "`error`" + # - "`suggestion`" # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity @@ -482,9 +482,9 @@ module Google attr_accessor :num_items # Acceptable values are: - # - "critical" - # - "error" - # - "suggestion" + # - "`critical`" + # - "`error`" + # - "`suggestion`" # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity @@ -624,8 +624,8 @@ module Google # The channel the data applies to. # Acceptable values are: - # - "local" - # - "online" + # - "`local`" + # - "`online`" # Corresponds to the JSON property `channel` # @return [String] attr_accessor :channel @@ -839,11 +839,11 @@ module Google # Status of the link between this Merchant Center account and the YouTube # channel. Upon retrieval, it represents the actual status of the link and can - # be either active if it was approved in YT Creator Studio or pending if it's - # pending approval. Upon insertion, it represents the intended status of the - # link. Re-uploading a link with status active when it's still pending or with - # status pending when it's already active will have no effect: the status will - # remain unchanged. Re-uploading a link with deprecated status inactive is + # be either `active` if it was approved in YT Creator Studio or `pending` if it' + # s pending approval. Upon insertion, it represents the intended status of the + # link. Re-uploading a link with status `active` when it's still pending or with + # status `pending` when it's already active will have no effect: the status will + # remain unchanged. Re-uploading a link with deprecated status `inactive` is # equivalent to not submitting the link at all and will delete the link if it # was active or cancel the link request if it was pending. # Corresponds to the JSON property `status` @@ -941,7 +941,7 @@ module Google # @return [Google::Apis::ContentV2::Account] attr_accessor :account - # The ID of the targeted account. Only defined if the method is not insert. + # The ID of the targeted account. Only defined if the method is not `insert`. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id @@ -952,13 +952,13 @@ module Google attr_accessor :batch_id # Whether the account should be deleted if the account has offers. Only - # applicable if the method is delete. + # applicable if the method is `delete`. # Corresponds to the JSON property `force` # @return [Boolean] attr_accessor :force alias_method :force?, :force - # Details about the link request. + # Details about the `link` request. # Corresponds to the JSON property `linkRequest` # @return [Google::Apis::ContentV2::AccountsCustomBatchRequestEntryLinkRequest] attr_accessor :link_request @@ -970,17 +970,17 @@ module Google # The method of the batch entry. # Acceptable values are: - # - "claimWebsite" - # - "delete" - # - "get" - # - "insert" - # - "link" - # - "update" + # - "`claimWebsite`" + # - "`delete`" + # - "`get`" + # - "`insert`" + # - "`link`" + # - "`update`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method - # Only applicable if the method is claimwebsite. Indicates whether or not to + # Only applicable if the method is `claimwebsite`. Indicates whether or not to # take the claim from another account in case there is a conflict. # Corresponds to the JSON property `overwrite` # @return [Boolean] @@ -1008,20 +1008,20 @@ module Google class AccountsCustomBatchRequestEntryLinkRequest include Google::Apis::Core::Hashable - # Action to perform for this link. The "request" action is only available to + # Action to perform for this link. The `"request"` action is only available to # select merchants. # Acceptable values are: - # - "approve" - # - "remove" - # - "request" + # - "`approve`" + # - "`remove`" + # - "`request`" # Corresponds to the JSON property `action` # @return [String] attr_accessor :action # Type of the link between the two accounts. # Acceptable values are: - # - "channelPartner" - # - "eCommercePlatform" + # - "`channelPartner`" + # - "`eCommercePlatform`" # Corresponds to the JSON property `linkType` # @return [String] attr_accessor :link_type @@ -1090,17 +1090,17 @@ module Google # @return [Google::Apis::ContentV2::Errors] attr_accessor :errors - # Identifies what kind of resource this is. Value: the fixed string "content# - # accountsCustomBatchResponseEntry". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # accountsCustomBatchResponseEntry`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Deprecated. This field is never set. # Acceptable values are: - # - "active" - # - "inactive" - # - "pending" + # - "`active`" + # - "`inactive`" + # - "`pending`" # Corresponds to the JSON property `linkStatus` # @return [String] attr_accessor :link_status @@ -1123,20 +1123,20 @@ module Google class AccountsLinkRequest include Google::Apis::Core::Hashable - # Action to perform for this link. The "request" action is only available to + # Action to perform for this link. The `"request"` action is only available to # select merchants. # Acceptable values are: - # - "approve" - # - "remove" - # - "request" + # - "`approve`" + # - "`remove`" + # - "`request`" # Corresponds to the JSON property `action` # @return [String] attr_accessor :action # Type of the link between the two accounts. # Acceptable values are: - # - "channelPartner" - # - "eCommercePlatform" + # - "`channelPartner`" + # - "`eCommercePlatform`" # Corresponds to the JSON property `linkType` # @return [String] attr_accessor :link_type @@ -1256,7 +1256,7 @@ module Google # The method of the batch entry. # Acceptable values are: - # - "get" + # - "`get`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method @@ -1410,8 +1410,8 @@ module Google # The method of the batch entry. # Acceptable values are: - # - "get" - # - "update" + # - "`get`" + # - "`update`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method @@ -1475,8 +1475,8 @@ module Google # @return [Google::Apis::ContentV2::Errors] attr_accessor :errors - # Identifies what kind of resource this is. Value: the fixed string "content# - # accounttaxCustomBatchResponseEntry". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # accounttaxCustomBatchResponseEntry`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1574,21 +1574,22 @@ module Google class CarrierRate include Google::Apis::Core::Hashable - # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can - # be retrieved via the getSupportedCarriers method. Required. + # Carrier service, such as `"UPS"` or `"Fedex"`. The list of supported carriers + # can be retrieved via the `getSupportedCarriers` method. Required. # Corresponds to the JSON property `carrierName` # @return [String] attr_accessor :carrier_name - # Carrier service, such as "ground" or "2 days". The list of supported services - # for a carrier can be retrieved via the getSupportedCarriers method. Required. + # Carrier service, such as `"ground"` or `"2 days"`. The list of supported + # services for a carrier can be retrieved via the `getSupportedCarriers` method. + # Required. # Corresponds to the JSON property `carrierService` # @return [String] attr_accessor :carrier_service - # Additive shipping rate modifier. Can be negative. For example ` "value": "1", " - # currency" : "USD" ` adds $1 to the rate, ` "value": "-3", "currency" : "USD" ` - # removes $3 from the rate. Optional. + # Additive shipping rate modifier. Can be negative. For example `` "value": "1", + # "currency" : "USD" `` adds $1 to the rate, `` "value": "-3", "currency" : "USD" + # `` removes $3 from the rate. Optional. # Corresponds to the JSON property `flatAdjustment` # @return [Google::Apis::ContentV2::Price] attr_accessor :flat_adjustment @@ -1604,7 +1605,7 @@ module Google attr_accessor :origin_postal_code # Multiplicative shipping rate modifier as a number in decimal notation. Can be - # negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the + # negative. For example `"5.4"` increases the rate by 5.4%, `"-3"` decreases the # rate by 3%. Optional. # Corresponds to the JSON property `percentageAdjustment` # @return [String] @@ -1634,12 +1635,12 @@ module Google # @return [String] attr_accessor :country - # The name of the carrier (e.g., "UPS"). Always present. + # The name of the carrier (e.g., `"UPS"`). Always present. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # A list of supported services (e.g., "ground") for that carrier. Contains at + # A list of supported services (e.g., `"ground"`) for that carrier. Contains at # least one service. # Corresponds to the JSON property `services` # @return [Array] @@ -1669,15 +1670,15 @@ module Google # The type of the attribute. # Acceptable values are: - # - "boolean" - # - "datetimerange" - # - "float" - # - "group" - # - "int" - # - "price" - # - "text" - # - "time" - # - "url" + # - "`boolean`" + # - "`datetimerange`" + # - "`float`" + # - "`group`" + # - "`int`" + # - "`price`" + # - "`text`" + # - "`time`" + # - "`url`" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -1742,20 +1743,20 @@ module Google # Code of the return reason. # Acceptable values are: - # - "betterPriceFound" - # - "changedMind" - # - "damagedOrDefectiveItem" - # - "didNotMatchDescription" - # - "doesNotFit" - # - "expiredItem" - # - "incorrectItemReceived" - # - "noLongerNeeded" - # - "notSpecified" - # - "orderedWrongItem" - # - "other" - # - "qualityNotExpected" - # - "receivedTooLate" - # - "undeliverable" + # - "`betterPriceFound`" + # - "`changedMind`" + # - "`damagedOrDefectiveItem`" + # - "`didNotMatchDescription`" + # - "`doesNotFit`" + # - "`expiredItem`" + # - "`incorrectItemReceived`" + # - "`noLongerNeeded`" + # - "`notSpecified`" + # - "`orderedWrongItem`" + # - "`other`" + # - "`qualityNotExpected`" + # - "`receivedTooLate`" + # - "`undeliverable`" # Corresponds to the JSON property `reasonCode` # @return [String] attr_accessor :reason_code @@ -1816,7 +1817,8 @@ module Google attr_accessor :attribute_language # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 - # language of the items in the feed. Must be a valid language for targetCountry. + # language of the items in the feed. Must be a valid language for `targetCountry` + # . # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language @@ -1824,9 +1826,9 @@ module Google # Required. The type of data feed. For product inventory feeds, only feeds for # local stores, not online stores, are supported. # Acceptable values are: - # - "local products" - # - "product inventory" - # - "products" + # - "`local products`" + # - "`product inventory`" + # - "`products`" # Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type @@ -1854,14 +1856,14 @@ module Google # @return [Fixnum] attr_accessor :id - # [DEPRECATED] Please use targets[].includedDestinations instead. The list of + # [DEPRECATED] Please use targets[].includedDestinations instead. The list of # intended destinations (corresponds to checked check boxes in Merchant Center). # Corresponds to the JSON property `intendedDestinations` # @return [Array] attr_accessor :intended_destinations - # Identifies what kind of resource this is. Value: the fixed string "content# - # datafeed". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # datafeed`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1957,13 +1959,13 @@ module Google # The day of the week the feed file should be fetched. # Acceptable values are: - # - "monday" - # - "tuesday" - # - "wednesday" - # - "thursday" - # - "friday" - # - "saturday" - # - "sunday" + # - "`monday`" + # - "`tuesday`" + # - "`wednesday`" + # - "`thursday`" + # - "`friday`" + # - "`saturday`" + # - "`sunday`" # Corresponds to the JSON property `weekday` # @return [String] attr_accessor :weekday @@ -1994,9 +1996,9 @@ module Google # If not specified, the delimiter will be auto-detected. Ignored for non-DSV # data feeds. # Acceptable values are: - # - "pipe" - # - "tab" - # - "tilde" + # - "`pipe`" + # - "`tab`" + # - "`tilde`" # Corresponds to the JSON property `columnDelimiter` # @return [String] attr_accessor :column_delimiter @@ -2004,11 +2006,11 @@ module Google # Character encoding scheme of the data feed. If not specified, the encoding # will be auto-detected. # Acceptable values are: - # - "latin-1" - # - "utf-16be" - # - "utf-16le" - # - "utf-8" - # - "windows-1252" + # - "`latin-1`" + # - "`utf-16be`" + # - "`utf-16le`" + # - "`utf-8`" + # - "`windows-1252`" # Corresponds to the JSON property `fileEncoding` # @return [String] attr_accessor :file_encoding @@ -2016,8 +2018,8 @@ module Google # Specifies how double quotes are interpreted. If not specified, the mode will # be auto-detected. Ignored for non-DSV data feeds. # Acceptable values are: - # - "normal character" - # - "value quoting" + # - "`normal character`" + # - "`value quoting`" # Corresponds to the JSON property `quotingMode` # @return [String] attr_accessor :quoting_mode @@ -2065,8 +2067,8 @@ module Google # @return [Fixnum] attr_accessor :items_valid - # Identifies what kind of resource this is. Value: the fixed string "content# - # datafeedStatus". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # datafeedStatus`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2083,12 +2085,12 @@ module Google # The processing status of the feed. # Acceptable values are: - # - ""failure": The feed could not be processed or all items had errors." - # - "in progress": The feed is being processed. - # - "none": The feed has not yet been processed. For example, a feed that has + # - "`"`failure`": The feed could not be processed or all items had errors.`" + # - "`in progress`": The feed is being processed. + # - "`none`": The feed has not yet been processed. For example, a feed that has # never been uploaded will have this processing status. - # - "success": The feed was processed successfully, though some items might have - # had errors. + # - "`success`": The feed was processed successfully, though some items might + # have had errors. # Corresponds to the JSON property `processingStatus` # @return [String] attr_accessor :processing_status @@ -2203,7 +2205,7 @@ module Google # The list of destinations to include for this target (corresponds to checked # check boxes in Merchant Center). Default destinations are always included - # unless provided in excludedDestinations. + # unless provided in `excludedDestinations`. # List of supported destinations (if available to the account): # - DisplayAds # - Shopping @@ -2214,7 +2216,7 @@ module Google attr_accessor :included_destinations # The two-letter ISO 639-1 language of the items in the feed. Must be a valid - # language for targets[].country. + # language for `targets[].country`. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language @@ -2277,11 +2279,11 @@ module Google # The method of the batch entry. # Acceptable values are: - # - "delete" - # - "fetchNow" - # - "get" - # - "insert" - # - "update" + # - "`delete`" + # - "`fetchNow`" + # - "`get`" + # - "`insert`" + # - "`update`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method @@ -2463,7 +2465,7 @@ module Google # The method of the batch entry. # Acceptable values are: - # - "get" + # - "`get`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method @@ -2596,15 +2598,15 @@ module Google attr_accessor :holiday_cutoffs # Maximum number of business days spent before an order is shipped. 0 means same - # day shipped, 1 means next day shipped. Must be greater than or equal to - # minHandlingTimeInDays. + # day shipped, 1 means next day shipped. Must be greater than or equal to ` + # minHandlingTimeInDays`. # Corresponds to the JSON property `maxHandlingTimeInDays` # @return [Fixnum] attr_accessor :max_handling_time_in_days # Maximum number of business days that is spent in transit. 0 means same day - # delivery, 1 means next day delivery. Must be greater than or equal to - # minTransitTimeInDays. + # delivery, 1 means next day delivery. Must be greater than or equal to ` + # minTransitTimeInDays`. # Corresponds to the JSON property `maxTransitTimeInDays` # @return [Fixnum] attr_accessor :max_transit_time_in_days @@ -2616,8 +2618,8 @@ module Google attr_accessor :min_handling_time_in_days # Minimum number of business days that is spent in transit. 0 means same day - # delivery, 1 means next day delivery. Either `min,max`TransitTimeInDays or - # transitTimeTable must be set, but not both. + # delivery, 1 means next day delivery. Either ``min,max`TransitTimeInDays` or ` + # transitTimeTable` must be set, but not both. # Corresponds to the JSON property `minTransitTimeInDays` # @return [Fixnum] attr_accessor :min_transit_time_in_days @@ -2629,8 +2631,8 @@ module Google attr_accessor :transit_business_day_config # Transit time table, number of business days spent in transit based on row and - # column dimensions. Either `min,max`TransitTimeInDays or transitTimeTable can - # be set, but not both. + # column dimensions. Either ``min,max`TransitTimeInDays` or `transitTimeTable` + # can be set, but not both. # Corresponds to the JSON property `transitTimeTable` # @return [Google::Apis::ContentV2::TransitTable] attr_accessor :transit_time_table @@ -2688,7 +2690,7 @@ module Google class Errors include Google::Apis::Core::Hashable - # The HTTP status of the first error in errors. + # The HTTP status of the first error in `errors`. # Corresponds to the JSON property `code` # @return [Fixnum] attr_accessor :code @@ -2698,7 +2700,7 @@ module Google # @return [Array] attr_accessor :errors - # The message of the first error in errors. + # The message of the first error in `errors`. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -2719,7 +2721,7 @@ module Google class GmbAccounts include Google::Apis::Core::Hashable - # The ID of the account. + # The ID of the Merchant Center account. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id @@ -2777,8 +2779,8 @@ module Google end end - # A non-empty list of row or column headers for a table. Exactly one of prices, - # weights, numItems, postalCodeGroupNames, or location must be set. + # A non-empty list of row or column headers for a table. Exactly one of `prices`, + # `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set. class Headers include Google::Apis::Core::Hashable @@ -2788,36 +2790,36 @@ module Google # @return [Array] attr_accessor :locations - # A list of inclusive number of items upper bounds. The last value can be " - # infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 - # items", " 50 items". Must be non-empty. Can only be set if all other fields + # A list of inclusive number of items upper bounds. The last value can be `" + # infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= + # 10 items", " 50 items". Must be non-empty. Can only be set if all other fields # are not set. # Corresponds to the JSON property `numberOfItems` # @return [Array] attr_accessor :number_of_items - # A list of postal group names. The last value can be "all other locations". - # Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code - # groups must match the delivery country of the service. Must be non-empty. Can - # only be set if all other fields are not set. + # A list of postal group names. The last value can be `"all other locations"`. + # Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal + # code groups must match the delivery country of the service. Must be non-empty. + # Can only be set if all other fields are not set. # Corresponds to the JSON property `postalCodeGroupNames` # @return [Array] attr_accessor :postal_code_group_names - # A list of inclusive order price upper bounds. The last price's value can be " - # infinity". For example [`"value": "10", "currency": "USD"`, `"value": "500", " - # currency": "USD"`, `"value": "infinity", "currency": "USD"`] represents the + # A list of inclusive order price upper bounds. The last price's value can be `" + # infinity"`. For example `[`"value": "10", "currency": "USD"`, `"value": "500", + # "currency": "USD"`, `"value": "infinity", "currency": "USD"`]` represents the # headers "<= $10", " $500". All prices within a service must have the same # currency. Must be non-empty. Can only be set if all other fields are not set. # Corresponds to the JSON property `prices` # @return [Array] attr_accessor :prices - # A list of inclusive order weight upper bounds. The last weight's value can be " - # infinity". For example [`"value": "10", "unit": "kg"`, `"value": "50", "unit": - # "kg"`, `"value": "infinity", "unit": "kg"`] represents the headers "<= 10kg", " - # 50kg". All weights within a service must have the same unit. Must be non- - # empty. Can only be set if all other fields are not set. + # A list of inclusive order weight upper bounds. The last weight's value can be ` + # "infinity"`. For example `[`"value": "10", "unit": "kg"`, `"value": "50", " + # unit": "kg"`, `"value": "infinity", "unit": "kg"`]` represents the headers "<= + # 10kg", " 50kg". All weights within a service must have the same unit. Must be + # non-empty. Can only be set if all other fields are not set. # Corresponds to the JSON property `weights` # @return [Array] attr_accessor :weights @@ -2922,14 +2924,14 @@ module Google # The holiday type. Always present. # Acceptable values are: - # - "Christmas" - # - "Easter" - # - "Father's Day" - # - "Halloween" - # - "Independence Day (USA)" - # - "Mother's Day" - # - "Thanksgiving" - # - "Valentine's Day" + # - "`Christmas`" + # - "`Easter`" + # - "`Father's Day`" + # - "`Halloween`" + # - "`Independence Day (USA)`" + # - "`Mother's Day`" + # - "`Thanksgiving`" + # - "`Valentine's Day`" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -2974,15 +2976,15 @@ module Google end end - # + # (== resource_for v2.inventory ==) class Inventory include Google::Apis::Core::Hashable # The availability of the product. # Acceptable values are: - # - "in stock" - # - "out of stock" - # - "preorder" + # - "`in stock`" + # - "`out of stock`" + # - "`preorder`" # Corresponds to the JSON property `availability` # @return [String] attr_accessor :availability @@ -3027,8 +3029,8 @@ module Google # @return [String] attr_accessor :instore_product_location - # Identifies what kind of resource this is. Value: the fixed string "content# - # inventory". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # inventory`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3038,10 +3040,10 @@ module Google # @return [Google::Apis::ContentV2::LoyaltyPoints] attr_accessor :loyalty_points - # Store pickup information. Only supported for local inventory. Not setting - # pickup means "don't update" while setting it to the empty value (`` in JSON) - # means "delete". Otherwise, pickupMethod and pickupSla must be set together, - # unless pickupMethod is "not supported". + # Store pickup information. Only supported for local inventory. Not setting ` + # pickup` means "don't update" while setting it to the empty value (```` in JSON) + # means "delete". Otherwise, `pickupMethod` and `pickupSla` must be set + # together, unless `pickupMethod` is "not supported". # Corresponds to the JSON property `pickup` # @return [Google::Apis::ContentV2::InventoryPickup] attr_accessor :pickup @@ -3057,7 +3059,7 @@ module Google # @return [Fixnum] attr_accessor :quantity - # The sale price of the product. Mandatory if sale_price_effective_date is + # The sale price of the product. Mandatory if `sale_price_effective_date` is # defined. # Corresponds to the JSON property `salePrice` # @return [Google::Apis::ContentV2::Price] @@ -3128,7 +3130,7 @@ module Google # @return [Fixnum] attr_accessor :batch_id - # Price and availability of the product. + # (== resource_for v2.inventory ==) # Corresponds to the JSON property `inventory` # @return [Google::Apis::ContentV2::Inventory] attr_accessor :inventory @@ -3143,7 +3145,7 @@ module Google # @return [String] attr_accessor :product_id - # The code of the store for which to update price and availability. Use online + # The code of the store for which to update price and availability. Use `online` # to update price and availability of an online product. # Corresponds to the JSON property `storeCode` # @return [String] @@ -3203,8 +3205,8 @@ module Google # @return [Google::Apis::ContentV2::Errors] attr_accessor :errors - # Identifies what kind of resource this is. Value: the fixed string "content# - # inventoryCustomBatchResponseEntry". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # inventoryCustomBatchResponseEntry`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3228,30 +3230,30 @@ module Google # Whether store pickup is available for this offer and whether the pickup option # should be shown as buy, reserve, or not supported. Only supported for local # inventory. Unless the value is "not supported", must be submitted together - # with pickupSla. + # with `pickupSla`. # Acceptable values are: - # - "buy" - # - "not supported" - # - "reserve" - # - "ship to store" + # - "`buy`" + # - "`not supported`" + # - "`reserve`" + # - "`ship to store`" # Corresponds to the JSON property `pickupMethod` # @return [String] attr_accessor :pickup_method # The expected date that an order will be ready for pickup, relative to when the # order is placed. Only supported for local inventory. Must be submitted - # together with pickupMethod. + # together with `pickupMethod`. # Acceptable values are: - # - "five day" - # - "four day" - # - "multi day" - # - "multi week" - # - "next day" - # - "same day" - # - "seven day" - # - "six day" - # - "three day" - # - "two day" + # - "`five day`" + # - "`four day`" + # - "`multi day`" + # - "`multi week`" + # - "`next day`" + # - "`same day`" + # - "`seven day`" + # - "`six day`" + # - "`three day`" + # - "`two day`" # Corresponds to the JSON property `pickupSla` # @return [String] attr_accessor :pickup_sla @@ -3273,9 +3275,9 @@ module Google # The availability of the product. # Acceptable values are: - # - "in stock" - # - "out of stock" - # - "preorder" + # - "`in stock`" + # - "`out of stock`" + # - "`preorder`" # Corresponds to the JSON property `availability` # @return [String] attr_accessor :availability @@ -3325,10 +3327,10 @@ module Google # @return [Google::Apis::ContentV2::LoyaltyPoints] attr_accessor :loyalty_points - # Store pickup information. Only supported for local inventory. Not setting - # pickup means "don't update" while setting it to the empty value (`` in JSON) - # means "delete". Otherwise, pickupMethod and pickupSla must be set together, - # unless pickupMethod is "not supported". + # Store pickup information. Only supported for local inventory. Not setting ` + # pickup` means "don't update" while setting it to the empty value (```` in JSON) + # means "delete". Otherwise, `pickupMethod` and `pickupSla` must be set + # together, unless `pickupMethod` is "not supported". # Corresponds to the JSON property `pickup` # @return [Google::Apis::ContentV2::InventoryPickup] attr_accessor :pickup @@ -3344,7 +3346,7 @@ module Google # @return [Fixnum] attr_accessor :quantity - # The sale price of the product. Mandatory if sale_price_effective_date is + # The sale price of the product. Mandatory if `sale_price_effective_date` is # defined. # Corresponds to the JSON property `salePrice` # @return [Google::Apis::ContentV2::Price] @@ -3466,7 +3468,7 @@ module Google # [required] Type of the additional charge. # Acceptable values are: - # - "shipping" + # - "`shipping`" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -3488,9 +3490,9 @@ module Google # The status of the verification process for the About page. # Acceptable values are: - # - "active" - # - "inactive" - # - "pending" + # - "`active`" + # - "`inactive`" + # - "`pending`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -3584,18 +3586,18 @@ module Google # The status of the verification contact. # Acceptable values are: - # - "active" - # - "inactive" - # - "pending" + # - "`active`" + # - "`inactive`" + # - "`pending`" # Corresponds to the JSON property `inventoryVerificationContactStatus` # @return [String] attr_accessor :inventory_verification_contact_status # The status of the inventory verification process. # Acceptable values are: - # - "active" - # - "inactive" - # - "pending" + # - "`active`" + # - "`inactive`" + # - "`pending`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -3624,9 +3626,9 @@ module Google # The status of the ?On display to order? feature. # Acceptable values are: - # - "active" - # - "inactive" - # - "pending" + # - "`active`" + # - "`inactive`" + # - "`pending`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -3683,8 +3685,8 @@ module Google # @return [Array] attr_accessor :country_settings - # Identifies what kind of resource this is. Value: the fixed string "content# - # liaSettings". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # liaSettings`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3724,7 +3726,7 @@ module Google class LiasettingsCustomBatchRequestEntry include Google::Apis::Core::Hashable - # The ID of the account for which to get/update account shipping settings. + # The ID of the account for which to get/update account LIA settings. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id @@ -3769,12 +3771,12 @@ module Google # The method of the batch entry. # Acceptable values are: - # - "get" - # - "getAccessibleGmbAccounts" - # - "requestGmbAccess" - # - "requestInventoryVerification" - # - "setInventoryVerificationContact" - # - "update" + # - "`get`" + # - "`getAccessibleGmbAccounts`" + # - "`requestGmbAccess`" + # - "`requestInventoryVerification`" + # - "`setInventoryVerificationContact`" + # - "`update`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -3854,8 +3856,8 @@ module Google # @return [Google::Apis::ContentV2::GmbAccounts] attr_accessor :gmb_accounts - # Identifies what kind of resource this is. Value: the fixed string "content# - # liasettingsCustomBatchResponseEntry". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # liasettingsCustomBatchResponseEntry`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3890,7 +3892,7 @@ module Google class LiasettingsGetAccessibleGmbAccountsResponse include Google::Apis::Core::Hashable - # The ID of the account. + # The ID of the Merchant Center account. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id @@ -4191,11 +4193,11 @@ module Google # State of the item. # Acceptable values are: - # - "canceled" - # - "new" - # - "received" - # - "refunded" - # - "rejected" + # - "`canceled`" + # - "`new`" + # - "`received`" + # - "`refunded`" + # - "`rejected`" # Corresponds to the JSON property `state` # @return [String] attr_accessor :state @@ -4215,8 +4217,56 @@ module Google end end + # + class MinimumOrderValueTable + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `storeCodeSetWithMovs` + # @return [Array] + attr_accessor :store_code_set_with_movs + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @store_code_set_with_movs = args[:store_code_set_with_movs] if args.key?(:store_code_set_with_movs) + end + end + + # A list of store code sets sharing the same minimum order value. At least two + # sets are required and the last one must be empty, which signifies 'MOV for all + # other stores'. Each store code can only appear once across all the sets. All + # prices within a service must have the same currency. + class MinimumOrderValueTableStoreCodeSetWithMov + include Google::Apis::Core::Hashable + + # A list of unique store codes or empty for the catch all. + # Corresponds to the JSON property `storeCodes` + # @return [Array] + attr_accessor :store_codes + + # The minimum order value for the given stores. + # Corresponds to the JSON property `value` + # @return [Google::Apis::ContentV2::Price] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @store_codes = args[:store_codes] if args.key?(:store_codes) + @value = args[:value] if args.key?(:value) + end + end + # Order. Production access (all methods) requires the order manager role. - # Sandbox access does not. + # Sandbox access does not. (== resource_for v2.orders ==) (== resource_for v2.1. + # orders ==) class Order include Google::Apis::Core::Hashable @@ -4228,8 +4278,8 @@ module Google # Deprecated. # Acceptable values are: - # - "googleExpress" - # - "purchasesOnGoogle" + # - "`googleExpress`" + # - "`purchasesOnGoogle`" # Corresponds to the JSON property `channelType` # @return [String] attr_accessor :channel_type @@ -4239,7 +4289,7 @@ module Google # @return [Google::Apis::ContentV2::OrderCustomer] attr_accessor :customer - # Delivery details for shipments of type delivery. + # Delivery details for shipments of type `delivery`. # Corresponds to the JSON property `deliveryDetails` # @return [Google::Apis::ContentV2::OrderDeliveryDetails] attr_accessor :delivery_details @@ -4249,8 +4299,8 @@ module Google # @return [String] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string "content# - # order". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # order`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -4284,15 +4334,15 @@ module Google # The status of the payment. # Acceptable values are: - # - "paymentCaptured" - # - "paymentRejected" - # - "paymentSecured" - # - "pendingAuthorization" + # - "`paymentCaptured`" + # - "`paymentRejected`" + # - "`paymentSecured`" + # - "`pendingAuthorization`" # Corresponds to the JSON property `paymentStatus` # @return [String] attr_accessor :payment_status - # Pickup details for shipments of type pickup. + # Pickup details for shipments of type `pickup`. # Corresponds to the JSON property `pickupDetails` # @return [Google::Apis::ContentV2::OrderPickupDetails] attr_accessor :pickup_details @@ -4303,19 +4353,19 @@ module Google attr_accessor :placed_date # The details of the merchant provided promotions applied to the order. - # To determine which promotions apply to which products, check the Promotions[]. - # Benefits[].OfferIds field against the LineItems[].Product.OfferId field for - # each promotion. If a promotion is applied to more than 1 offerId, divide the + # To determine which promotions apply to which products, check the `Promotions[]. + # Benefits[].OfferIds` field against the `LineItems[].Product.OfferId` field for + # each promotion. If a promotion is applied to more than 1 `offerId`, divide the # discount value by the number of affected offers to determine how much discount - # to apply to each offerId. + # to apply to each `offerId`. # Examples: # - To calculate the line item level discount for a single specific item: For - # each promotion, subtract the Promotions[].Benefits[].Discount.value amount - # from the LineItems[].Price.value. + # each promotion, subtract the `Promotions[].Benefits[].Discount.value` amount + # from the `LineItems[].Price.value`. # - To calculate the line item level discount for multiple quantity of a - # specific item: For each promotion, divide the Promotions[].Benefits[].Discount. - # value by the quantity of products and substract it from LineItems[].Product. - # Price.value for each quantity item. + # specific item: For each promotion, divide the `Promotions[].Benefits[]. + # Discount.value` by the quantity of products and substract it from `LineItems[]. + # Product.Price.value` for each quantity item. # Only 1 promotion can be applied to an offerId in a given order. To refund an # item which had a promotion applied to it, make sure to refund the amount after # first subtracting the promotion discount from the item price. @@ -4346,35 +4396,35 @@ module Google # Deprecated. Shipping details are provided with line items instead. # Acceptable values are: - # - "economy" - # - "expedited" - # - "oneDay" - # - "sameDay" - # - "standard" - # - "twoDay" + # - "`economy`" + # - "`expedited`" + # - "`oneDay`" + # - "`sameDay`" + # - "`standard`" + # - "`twoDay`" # Corresponds to the JSON property `shippingOption` # @return [String] attr_accessor :shipping_option # The status of the order. # Acceptable values are: - # - "canceled" - # - "delivered" - # - "inProgress" - # - "partiallyDelivered" - # - "partiallyReturned" - # - "partiallyShipped" - # - "pendingShipment" - # - "returned" - # - "shipped" + # - "`canceled`" + # - "`delivered`" + # - "`inProgress`" + # - "`partiallyDelivered`" + # - "`partiallyReturned`" + # - "`partiallyShipped`" + # - "`pendingShipment`" + # - "`returned`" + # - "`shipped`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The party responsible for collecting and remitting taxes. # Acceptable values are: - # - "marketplaceFacilitator" - # - "merchant" + # - "`marketplaceFacilitator`" + # - "`merchant`" # Corresponds to the JSON property `taxCollector` # @return [String] attr_accessor :tax_collector @@ -4485,12 +4535,12 @@ module Google # The actor that created the cancellation. # Acceptable values are: - # - "customer" - # - "googleBot" - # - "googleCustomerService" - # - "googlePayments" - # - "googleSabre" - # - "merchant" + # - "`customer`" + # - "`googleBot`" + # - "`googleCustomerService`" + # - "`googlePayments`" + # - "`googleSabre`" + # - "`merchant`" # Corresponds to the JSON property `actor` # @return [String] attr_accessor :actor @@ -4509,34 +4559,34 @@ module Google # reason will lead to the removal of the product from Shopping Actions until you # make an update to that product. This will not affect your Shopping ads. # Acceptable values are: - # - "autoPostInternal" - # - "autoPostInvalidBillingAddress" - # - "autoPostNoInventory" - # - "autoPostPriceError" - # - "autoPostUndeliverableShippingAddress" - # - "couponAbuse" - # - "customerCanceled" - # - "customerInitiatedCancel" - # - "customerSupportRequested" - # - "failToPushOrderGoogleError" - # - "failToPushOrderMerchantError" - # - "failToPushOrderMerchantFulfillmentError" - # - "failToPushOrderToMerchant" - # - "failToPushOrderToMerchantOutOfStock" - # - "invalidCoupon" - # - "malformedShippingAddress" - # - "merchantDidNotShipOnTime" - # - "noInventory" - # - "orderTimeout" - # - "other" - # - "paymentAbuse" - # - "paymentDeclined" - # - "priceError" - # - "returnRefundAbuse" - # - "shippingPriceError" - # - "taxError" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" + # - "`autoPostInternal`" + # - "`autoPostInvalidBillingAddress`" + # - "`autoPostNoInventory`" + # - "`autoPostPriceError`" + # - "`autoPostUndeliverableShippingAddress`" + # - "`couponAbuse`" + # - "`customerCanceled`" + # - "`customerInitiatedCancel`" + # - "`customerSupportRequested`" + # - "`failToPushOrderGoogleError`" + # - "`failToPushOrderMerchantError`" + # - "`failToPushOrderMerchantFulfillmentError`" + # - "`failToPushOrderToMerchant`" + # - "`failToPushOrderToMerchantOutOfStock`" + # - "`invalidCoupon`" + # - "`malformedShippingAddress`" + # - "`merchantDidNotShipOnTime`" + # - "`noInventory`" + # - "`orderTimeout`" + # - "`other`" + # - "`paymentAbuse`" + # - "`paymentDeclined`" + # - "`priceError`" + # - "`returnRefundAbuse`" + # - "`shippingPriceError`" + # - "`taxError`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -4581,8 +4631,9 @@ module Google attr_accessor :full_name # Email address for the merchant to send value-added tax or invoice - # documentation of the order. This documentation is made available to the - # customer. + # documentation of the order. Only the last document sent is made available to + # the customer. For more information, see About automated VAT invoicing for + # Shopping Actions. # Corresponds to the JSON property `invoiceReceivingEmail` # @return [String] attr_accessor :invoice_receiving_email @@ -4615,12 +4666,12 @@ module Google # Last known customer selection regarding marketing preferences. In certain # cases this selection might not be known, so this field would be empty. If a - # customer selected granted in their most recent order, they can be subscribed - # to marketing emails. Customers who have chosen denied must not be subscribed, + # customer selected `granted` in their most recent order, they can be subscribed + # to marketing emails. Customers who have chosen `denied` must not be subscribed, # or must be unsubscribed if already opted-in. # Acceptable values are: - # - "denied" - # - "granted" + # - "`denied`" + # - "`granted`" # Corresponds to the JSON property `explicitMarketingPreference` # @return [String] attr_accessor :explicit_marketing_preference @@ -4632,8 +4683,8 @@ module Google attr_accessor :last_updated_timestamp # Email address that can be used for marketing purposes. The field may be empty - # even if explicitMarketingPreference is 'granted'. This happens when retrieving - # an old order from the customer who deleted their account. + # even if `explicitMarketingPreference` is 'granted'. This happens when + # retrieving an old order from the customer who deleted their account. # Corresponds to the JSON property `marketingEmailAddress` # @return [String] attr_accessor :marketing_email_address @@ -4713,15 +4764,15 @@ module Google # Whether the promotion is applicable to all products or only specific products. # Acceptable values are: - # - "allProducts" - # - "specificProducts" + # - "`allProducts`" + # - "`specificProducts`" # Corresponds to the JSON property `productApplicability` # @return [String] attr_accessor :product_applicability # Indicates that the promotion is valid online. # Acceptable values are: - # - "online" + # - "`online`" # Corresponds to the JSON property `redemptionChannel` # @return [String] attr_accessor :redemption_channel @@ -4760,20 +4811,20 @@ module Google # Further describes the benefit of the promotion. Note that we will expand on # this enumeration as we support new promotion sub-types. # Acceptable values are: - # - "buyMGetMoneyOff" - # - "buyMGetNMoneyOff" - # - "buyMGetNPercentOff" - # - "buyMGetPercentOff" - # - "freeGift" - # - "freeGiftWithItemId" - # - "freeGiftWithValue" - # - "freeOvernightShipping" - # - "freeShipping" - # - "freeTwoDayShipping" - # - "moneyOff" - # - "percentageOff" - # - "rewardPoints" - # - "salePrice" + # - "`buyMGetMoneyOff`" + # - "`buyMGetNMoneyOff`" + # - "`buyMGetNPercentOff`" + # - "`buyMGetPercentOff`" + # - "`freeGift`" + # - "`freeGiftWithItemId`" + # - "`freeGiftWithValue`" + # - "`freeOvernightShipping`" + # - "`freeShipping`" + # - "`freeTwoDayShipping`" + # - "`moneyOff`" + # - "`percentageOff`" + # - "`rewardPoints`" + # - "`salePrice`" # Corresponds to the JSON property `subType` # @return [String] attr_accessor :sub_type @@ -4786,8 +4837,8 @@ module Google # Describes whether the promotion applies to products (e.g. 20% off) or to # shipping (e.g. Free Shipping). # Acceptable values are: - # - "product" - # - "shipping" + # - "`product`" + # - "`shipping`" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -4930,17 +4981,17 @@ module Google # The item's channel (online or local). # Acceptable values are: - # - "local" - # - "online" + # - "`local`" + # - "`online`" # Corresponds to the JSON property `channel` # @return [String] attr_accessor :channel # Condition or state of the item. # Acceptable values are: - # - "new" - # - "refurbished" - # - "used" + # - "`new`" + # - "`refurbished`" + # - "`used`" # Corresponds to the JSON property `condition` # @return [String] attr_accessor :condition @@ -5138,11 +5189,11 @@ module Google # @return [String] attr_accessor :ship_by_date - # Type of shipment. Indicates whether deliveryDetails or pickupDetails is + # Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is # applicable for this shipment. # Acceptable values are: - # - "delivery" - # - "pickup" + # - "`delivery`" + # - "`pickup`" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -5164,8 +5215,8 @@ module Google class OrderLineItemShippingDetailsMethod include Google::Apis::Core::Hashable - # The carrier for the shipping. Optional. See shipments[].carrier for a list of - # acceptable values. + # The carrier for the shipping. Optional. See `shipments[].carrier` for a list + # of acceptable values. # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier @@ -5256,13 +5307,13 @@ module Google # The type of instrument. # Acceptable values are: - # - "AMEX" - # - "DISCOVER" - # - "JCB" - # - "MASTERCARD" - # - "UNIONPAY" - # - "VISA" - # - "" + # - "`AMEX`" + # - "`DISCOVER`" + # - "`JCB`" + # - "`MASTERCARD`" + # - "`UNIONPAY`" + # - "`VISA`" + # - "``" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -5286,8 +5337,8 @@ module Google class OrderPickupDetails include Google::Apis::Core::Hashable - # Address of the pickup location where the shipment should be sent. Note that - # recipientName in the address is the name of the business at the pickup + # Address of the pickup location where the shipment should be sent. Note that ` + # recipientName` in the address is the name of the business at the pickup # location. # Corresponds to the JSON property `address` # @return [Google::Apis::ContentV2::OrderAddress] @@ -5346,12 +5397,12 @@ module Google # The actor that created the refund. # Acceptable values are: - # - "customer" - # - "googleBot" - # - "googleCustomerService" - # - "googlePayments" - # - "googleSabre" - # - "merchant" + # - "`customer`" + # - "`googleBot`" + # - "`googleCustomerService`" + # - "`googlePayments`" + # - "`googleSabre`" + # - "`merchant`" # Corresponds to the JSON property `actor` # @return [String] attr_accessor :actor @@ -5368,50 +5419,50 @@ module Google # The reason for the refund. # Acceptable values are: - # - "adjustment" - # - "autoPostInternal" - # - "autoPostInvalidBillingAddress" - # - "autoPostNoInventory" - # - "autoPostPriceError" - # - "autoPostUndeliverableShippingAddress" - # - "couponAbuse" - # - "courtesyAdjustment" - # - "customerCanceled" - # - "customerDiscretionaryReturn" - # - "customerInitiatedMerchantCancel" - # - "customerSupportRequested" - # - "deliveredLateByCarrier" - # - "deliveredTooLate" - # - "expiredItem" - # - "failToPushOrderGoogleError" - # - "failToPushOrderMerchantError" - # - "failToPushOrderMerchantFulfillmentError" - # - "failToPushOrderToMerchant" - # - "failToPushOrderToMerchantOutOfStock" - # - "feeAdjustment" - # - "invalidCoupon" - # - "lateShipmentCredit" - # - "malformedShippingAddress" - # - "merchantDidNotShipOnTime" - # - "noInventory" - # - "orderTimeout" - # - "other" - # - "paymentAbuse" - # - "paymentDeclined" - # - "priceAdjustment" - # - "priceError" - # - "productArrivedDamaged" - # - "productNotAsDescribed" - # - "promoReallocation" - # - "qualityNotAsExpected" - # - "returnRefundAbuse" - # - "shippingCostAdjustment" - # - "shippingPriceError" - # - "taxAdjustment" - # - "taxError" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" - # - "wrongProductShipped" + # - "`adjustment`" + # - "`autoPostInternal`" + # - "`autoPostInvalidBillingAddress`" + # - "`autoPostNoInventory`" + # - "`autoPostPriceError`" + # - "`autoPostUndeliverableShippingAddress`" + # - "`couponAbuse`" + # - "`courtesyAdjustment`" + # - "`customerCanceled`" + # - "`customerDiscretionaryReturn`" + # - "`customerInitiatedMerchantCancel`" + # - "`customerSupportRequested`" + # - "`deliveredLateByCarrier`" + # - "`deliveredTooLate`" + # - "`expiredItem`" + # - "`failToPushOrderGoogleError`" + # - "`failToPushOrderMerchantError`" + # - "`failToPushOrderMerchantFulfillmentError`" + # - "`failToPushOrderToMerchant`" + # - "`failToPushOrderToMerchantOutOfStock`" + # - "`feeAdjustment`" + # - "`invalidCoupon`" + # - "`lateShipmentCredit`" + # - "`malformedShippingAddress`" + # - "`merchantDidNotShipOnTime`" + # - "`noInventory`" + # - "`orderTimeout`" + # - "`other`" + # - "`paymentAbuse`" + # - "`paymentDeclined`" + # - "`priceAdjustment`" + # - "`priceError`" + # - "`productArrivedDamaged`" + # - "`productNotAsDescribed`" + # - "`promoReallocation`" + # - "`qualityNotAsExpected`" + # - "`returnRefundAbuse`" + # - "`shippingCostAdjustment`" + # - "`shippingPriceError`" + # - "`taxAdjustment`" + # - "`taxError`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" + # - "`wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -5435,7 +5486,8 @@ module Google end end - # Order disbursement. All methods require the payment analyst role. + # Order disbursement. All methods require the payment analyst role. (== + # resource_for v2.orderreports ==) (== resource_for v2.1.orderreports ==) class OrderReportDisbursement include Google::Apis::Core::Hashable @@ -5557,12 +5609,12 @@ module Google # The actor that created the refund. # Acceptable values are: - # - "customer" - # - "googleBot" - # - "googleCustomerService" - # - "googlePayments" - # - "googleSabre" - # - "merchant" + # - "`customer`" + # - "`googleBot`" + # - "`googleCustomerService`" + # - "`googlePayments`" + # - "`googleSabre`" + # - "`merchant`" # Corresponds to the JSON property `actor` # @return [String] attr_accessor :actor @@ -5579,19 +5631,19 @@ module Google # The reason for the return. # Acceptable values are: - # - "customerDiscretionaryReturn" - # - "customerInitiatedMerchantCancel" - # - "deliveredTooLate" - # - "expiredItem" - # - "invalidCoupon" - # - "malformedShippingAddress" - # - "other" - # - "productArrivedDamaged" - # - "productNotAsDescribed" - # - "qualityNotAsExpected" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" - # - "wrongProductShipped" + # - "`customerDiscretionaryReturn`" + # - "`customerInitiatedMerchantCancel`" + # - "`deliveredTooLate`" + # - "`expiredItem`" + # - "`invalidCoupon`" + # - "`malformedShippingAddress`" + # - "`other`" + # - "`productArrivedDamaged`" + # - "`productNotAsDescribed`" + # - "`qualityNotAsExpected`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" + # - "`wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -5627,42 +5679,42 @@ module Google # carrier name or tracking URL, and there will be no automatic order status # updates. # Supported carriers for US are: - # - "ups" (United Parcel Service) automatic status updates - # - "usps" (United States Postal Service) automatic status updates - # - "fedex" (FedEx) automatic status updates - # - "dhl" (DHL eCommerce) automatic status updates (US only) - # - "ontrac" (OnTrac) automatic status updates - # - "dhl express" (DHL Express) - # - "deliv" (Deliv) - # - "dynamex" (TForce) - # - "lasership" (LaserShip) - # - "mpx" (Military Parcel Xpress) - # - "uds" (United Delivery Service) - # - "efw" (Estes Forwarding Worldwide) - # - "jd logistics" (JD Logistics) - # - "yunexpress" (YunExpress) - # - "china post" (China Post) - # - "china ems" (China Post Express Mail Service) - # - "singapore post" (Singapore Post) - # - "pos malaysia" (Pos Malaysia) - # - "postnl" (PostNL) - # - "ptt" (PTT Turkish Post) - # - "eub" (ePacket) - # - "chukou1" (Chukou1 Logistics) + # - "`ups`" (United Parcel Service) automatic status updates + # - "`usps`" (United States Postal Service) automatic status updates + # - "`fedex`" (FedEx) automatic status updates + # - "`dhl`" (DHL eCommerce) automatic status updates (US only) + # - "`ontrac`" (OnTrac) automatic status updates + # - "`dhl express`" (DHL Express) + # - "`deliv`" (Deliv) + # - "`dynamex`" (TForce) + # - "`lasership`" (LaserShip) + # - "`mpx`" (Military Parcel Xpress) + # - "`uds`" (United Delivery Service) + # - "`efw`" (Estes Forwarding Worldwide) + # - "`jd logistics`" (JD Logistics) + # - "`yunexpress`" (YunExpress) + # - "`china post`" (China Post) + # - "`china ems`" (China Post Express Mail Service) + # - "`singapore post`" (Singapore Post) + # - "`pos malaysia`" (Pos Malaysia) + # - "`postnl`" (PostNL) + # - "`ptt`" (PTT Turkish Post) + # - "`eub`" (ePacket) + # - "`chukou1`" (Chukou1 Logistics) # Supported carriers for FR are: - # - "la poste" (La Poste) automatic status updates - # - "colissimo" (Colissimo by La Poste) automatic status updates - # - "ups" (United Parcel Service) automatic status updates - # - "chronopost" (Chronopost by La Poste) - # - "gls" (General Logistics Systems France) - # - "dpd" (DPD Group by GeoPost) - # - "bpost" (Belgian Post Group) - # - "colis prive" (Colis Privé) - # - "boxtal" (Boxtal) - # - "geodis" (GEODIS) - # - "tnt" (TNT) - # - "db schenker" (DB Schenker) - # - "aramex" (Aramex) + # - "`la poste`" (La Poste) automatic status updates + # - "`colissimo`" (Colissimo by La Poste) automatic status updates + # - "`ups`" (United Parcel Service) automatic status updates + # - "`chronopost`" (Chronopost by La Poste) + # - "`gls`" (General Logistics Systems France) + # - "`dpd`" (DPD Group by GeoPost) + # - "`bpost`" (Belgian Post Group) + # - "`colis prive`" (Colis Privé) + # - "`boxtal`" (Boxtal) + # - "`geodis`" (GEODIS) + # - "`tnt`" (TNT) + # - "`db schenker`" (DB Schenker) + # - "`aramex`" (Aramex) # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier @@ -5673,7 +5725,7 @@ module Google attr_accessor :creation_date # Date on which the shipment has been delivered, in ISO 8601 format. Present - # only if status is delivered + # only if `status` is `delivered` # Corresponds to the JSON property `deliveryDate` # @return [String] attr_accessor :delivery_date @@ -5690,10 +5742,10 @@ module Google # The status of the shipment. # Acceptable values are: - # - "delivered" - # - "readyForPickup" - # - "shipped" - # - "undeliverable" + # - "`delivered`" + # - "`readyForPickup`" + # - "`shipped`" + # - "`undeliverable`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -5777,8 +5829,8 @@ module Google # @return [String] attr_accessor :operation_id - # [required] ID of the shipment group. It is assigned by the merchant in the - # shipLineItems method and is used to group multiple line items that have the + # [required] ID of the shipment group. It is assigned by the merchant in the ` + # shipLineItems` method and is used to group multiple line items that have the # same kind of shipping charges. # Corresponds to the JSON property `shipmentGroupId` # @return [String] @@ -5804,8 +5856,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -5842,14 +5894,15 @@ module Google # @return [String] attr_accessor :operation_id - # Option to create a refund-only invoice. Exactly one of refundOnlyOption or - # returnOption must be provided. + # Option to create a refund-only invoice. Exactly one of `refundOnlyOption` or ` + # returnOption` must be provided. # Corresponds to the JSON property `refundOnlyOption` # @return [Google::Apis::ContentV2::OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption] attr_accessor :refund_only_option # Option to create an invoice for a refund and mark all items within the invoice - # as returned. Exactly one of refundOnlyOption or returnOption must be provided. + # as returned. Exactly one of `refundOnlyOption` or `returnOption` must be + # provided. # Corresponds to the JSON property `returnOption` # @return [Google::Apis::ContentV2::OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption] attr_accessor :return_option @@ -5879,8 +5932,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -5913,50 +5966,50 @@ module Google # [required] Reason for the refund. # Acceptable values are: - # - "adjustment" - # - "autoPostInternal" - # - "autoPostInvalidBillingAddress" - # - "autoPostNoInventory" - # - "autoPostPriceError" - # - "autoPostUndeliverableShippingAddress" - # - "couponAbuse" - # - "courtesyAdjustment" - # - "customerCanceled" - # - "customerDiscretionaryReturn" - # - "customerInitiatedMerchantCancel" - # - "customerSupportRequested" - # - "deliveredLateByCarrier" - # - "deliveredTooLate" - # - "expiredItem" - # - "failToPushOrderGoogleError" - # - "failToPushOrderMerchantError" - # - "failToPushOrderMerchantFulfillmentError" - # - "failToPushOrderToMerchant" - # - "failToPushOrderToMerchantOutOfStock" - # - "feeAdjustment" - # - "invalidCoupon" - # - "lateShipmentCredit" - # - "malformedShippingAddress" - # - "merchantDidNotShipOnTime" - # - "noInventory" - # - "orderTimeout" - # - "other" - # - "paymentAbuse" - # - "paymentDeclined" - # - "priceAdjustment" - # - "priceError" - # - "productArrivedDamaged" - # - "productNotAsDescribed" - # - "promoReallocation" - # - "qualityNotAsExpected" - # - "returnRefundAbuse" - # - "shippingCostAdjustment" - # - "shippingPriceError" - # - "taxAdjustment" - # - "taxError" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" - # - "wrongProductShipped" + # - "`adjustment`" + # - "`autoPostInternal`" + # - "`autoPostInvalidBillingAddress`" + # - "`autoPostNoInventory`" + # - "`autoPostPriceError`" + # - "`autoPostUndeliverableShippingAddress`" + # - "`couponAbuse`" + # - "`courtesyAdjustment`" + # - "`customerCanceled`" + # - "`customerDiscretionaryReturn`" + # - "`customerInitiatedMerchantCancel`" + # - "`customerSupportRequested`" + # - "`deliveredLateByCarrier`" + # - "`deliveredTooLate`" + # - "`expiredItem`" + # - "`failToPushOrderGoogleError`" + # - "`failToPushOrderMerchantError`" + # - "`failToPushOrderMerchantFulfillmentError`" + # - "`failToPushOrderToMerchant`" + # - "`failToPushOrderToMerchantOutOfStock`" + # - "`feeAdjustment`" + # - "`invalidCoupon`" + # - "`lateShipmentCredit`" + # - "`malformedShippingAddress`" + # - "`merchantDidNotShipOnTime`" + # - "`noInventory`" + # - "`orderTimeout`" + # - "`other`" + # - "`paymentAbuse`" + # - "`paymentDeclined`" + # - "`priceAdjustment`" + # - "`priceError`" + # - "`productArrivedDamaged`" + # - "`productNotAsDescribed`" + # - "`promoReallocation`" + # - "`qualityNotAsExpected`" + # - "`returnRefundAbuse`" + # - "`shippingCostAdjustment`" + # - "`shippingPriceError`" + # - "`taxAdjustment`" + # - "`taxError`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" + # - "`wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -5983,19 +6036,19 @@ module Google # [required] Reason for the return. # Acceptable values are: - # - "customerDiscretionaryReturn" - # - "customerInitiatedMerchantCancel" - # - "deliveredTooLate" - # - "expiredItem" - # - "invalidCoupon" - # - "malformedShippingAddress" - # - "other" - # - "productArrivedDamaged" - # - "productNotAsDescribed" - # - "qualityNotAsExpected" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" - # - "wrongProductShipped" + # - "`customerDiscretionaryReturn`" + # - "`customerInitiatedMerchantCancel`" + # - "`deliveredTooLate`" + # - "`expiredItem`" + # - "`invalidCoupon`" + # - "`malformedShippingAddress`" + # - "`other`" + # - "`productArrivedDamaged`" + # - "`productNotAsDescribed`" + # - "`qualityNotAsExpected`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" + # - "`wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -6132,8 +6185,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -6221,16 +6274,16 @@ module Google # The reason for the cancellation. # Acceptable values are: - # - "customerInitiatedCancel" - # - "invalidCoupon" - # - "malformedShippingAddress" - # - "noInventory" - # - "other" - # - "priceError" - # - "shippingPriceError" - # - "taxError" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" + # - "`customerInitiatedCancel`" + # - "`invalidCoupon`" + # - "`malformedShippingAddress`" + # - "`noInventory`" + # - "`other`" + # - "`priceError`" + # - "`shippingPriceError`" + # - "`taxError`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -6264,8 +6317,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -6298,16 +6351,16 @@ module Google # The reason for the cancellation. # Acceptable values are: - # - "customerInitiatedCancel" - # - "invalidCoupon" - # - "malformedShippingAddress" - # - "noInventory" - # - "other" - # - "priceError" - # - "shippingPriceError" - # - "taxError" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" + # - "`customerInitiatedCancel`" + # - "`invalidCoupon`" + # - "`malformedShippingAddress`" + # - "`noInventory`" + # - "`other`" + # - "`priceError`" + # - "`shippingPriceError`" + # - "`taxError`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -6335,8 +6388,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -6364,9 +6417,9 @@ module Google # The reason for the cancellation. # Acceptable values are: - # - "changedMind" - # - "orderedWrongItem" - # - "other" + # - "`changedMind`" + # - "`orderedWrongItem`" + # - "`other`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -6406,24 +6459,24 @@ module Google include Google::Apis::Core::Hashable # The CLDR territory code of the country of the test order to create. Affects - # the currency and addresses of orders created via template_name, or the - # addresses of orders created via test_order. + # the currency and addresses of orders created via `template_name`, or the + # addresses of orders created via `test_order`. # Acceptable values are: - # - "US" - # - "FR" Defaults to US. + # - "`US`" + # - "`FR`" Defaults to `US`. # Corresponds to the JSON property `country` # @return [String] attr_accessor :country - # The test order template to use. Specify as an alternative to testOrder as a + # The test order template to use. Specify as an alternative to `testOrder` as a # shortcut for retrieving a template and then creating an order using that # template. # Acceptable values are: - # - "template1" - # - "template1a" - # - "template1b" - # - "template2" - # - "template3" + # - "`template1`" + # - "`template1a`" + # - "`template1b`" + # - "`template2`" + # - "`template3`" # Corresponds to the JSON property `templateName` # @return [String] attr_accessor :template_name @@ -6544,17 +6597,17 @@ module Google # @return [Fixnum] attr_accessor :batch_id - # Required for cancel method. + # Required for `cancel` method. # Corresponds to the JSON property `cancel` # @return [Google::Apis::ContentV2::OrdersCustomBatchRequestEntryCancel] attr_accessor :cancel - # Required for cancelLineItem method. + # Required for `cancelLineItem` method. # Corresponds to the JSON property `cancelLineItem` # @return [Google::Apis::ContentV2::OrdersCustomBatchRequestEntryCancelLineItem] attr_accessor :cancel_line_item - # Required for inStoreReturnLineItem method. + # Required for `inStoreReturnLineItem` method. # Corresponds to the JSON property `inStoreRefundLineItem` # @return [Google::Apis::ContentV2::OrdersCustomBatchRequestEntryInStoreRefundLineItem] attr_accessor :in_store_refund_line_item @@ -6564,80 +6617,80 @@ module Google # @return [Fixnum] attr_accessor :merchant_id - # The merchant order ID. Required for updateMerchantOrderId and - # getByMerchantOrderId methods. + # The merchant order ID. Required for `updateMerchantOrderId` and ` + # getByMerchantOrderId` methods. # Corresponds to the JSON property `merchantOrderId` # @return [String] attr_accessor :merchant_order_id # The method of the batch entry. # Acceptable values are: - # - "acknowledge" - # - "cancel" - # - "cancelLineItem" - # - "get" - # - "getByMerchantOrderId" - # - "inStoreRefundLineItem" - # - "refund" - # - "rejectReturnLineItem" - # - "returnLineItem" - # - "returnRefundLineItem" - # - "setLineItemMetadata" - # - "shipLineItems" - # - "updateLineItemShippingDetails" - # - "updateMerchantOrderId" - # - "updateShipment" + # - "`acknowledge`" + # - "`cancel`" + # - "`cancelLineItem`" + # - "`get`" + # - "`getByMerchantOrderId`" + # - "`inStoreRefundLineItem`" + # - "`refund`" + # - "`rejectReturnLineItem`" + # - "`returnLineItem`" + # - "`returnRefundLineItem`" + # - "`setLineItemMetadata`" + # - "`shipLineItems`" + # - "`updateLineItemShippingDetails`" + # - "`updateMerchantOrderId`" + # - "`updateShipment`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop # The ID of the operation. Unique across all operations for a given order. - # Required for all methods beside get and getByMerchantOrderId. + # Required for all methods beside `get` and `getByMerchantOrderId`. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id - # The ID of the order. Required for all methods beside getByMerchantOrderId. + # The ID of the order. Required for all methods beside `getByMerchantOrderId`. # Corresponds to the JSON property `orderId` # @return [String] attr_accessor :order_id - # Required for refund method. + # Required for `refund` method. # Corresponds to the JSON property `refund` # @return [Google::Apis::ContentV2::OrdersCustomBatchRequestEntryRefund] attr_accessor :refund - # Required for rejectReturnLineItem method. + # Required for `rejectReturnLineItem` method. # Corresponds to the JSON property `rejectReturnLineItem` # @return [Google::Apis::ContentV2::OrdersCustomBatchRequestEntryRejectReturnLineItem] attr_accessor :reject_return_line_item - # Required for returnLineItem method. + # Required for `returnLineItem` method. # Corresponds to the JSON property `returnLineItem` # @return [Google::Apis::ContentV2::OrdersCustomBatchRequestEntryReturnLineItem] attr_accessor :return_line_item - # Required for returnRefundLineItem method. + # Required for `returnRefundLineItem` method. # Corresponds to the JSON property `returnRefundLineItem` # @return [Google::Apis::ContentV2::OrdersCustomBatchRequestEntryReturnRefundLineItem] attr_accessor :return_refund_line_item - # Required for setLineItemMetadata method. + # Required for `setLineItemMetadata` method. # Corresponds to the JSON property `setLineItemMetadata` # @return [Google::Apis::ContentV2::OrdersCustomBatchRequestEntrySetLineItemMetadata] attr_accessor :set_line_item_metadata - # Required for shipLineItems method. + # Required for `shipLineItems` method. # Corresponds to the JSON property `shipLineItems` # @return [Google::Apis::ContentV2::OrdersCustomBatchRequestEntryShipLineItems] attr_accessor :ship_line_items - # Required for updateLineItemShippingDate method. + # Required for `updateLineItemShippingDate` method. # Corresponds to the JSON property `updateLineItemShippingDetails` # @return [Google::Apis::ContentV2::OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails] attr_accessor :update_line_item_shipping_details - # Required for updateShipment method. + # Required for `updateShipment` method. # Corresponds to the JSON property `updateShipment` # @return [Google::Apis::ContentV2::OrdersCustomBatchRequestEntryUpdateShipment] attr_accessor :update_shipment @@ -6674,16 +6727,16 @@ module Google # The reason for the cancellation. # Acceptable values are: - # - "customerInitiatedCancel" - # - "invalidCoupon" - # - "malformedShippingAddress" - # - "noInventory" - # - "other" - # - "priceError" - # - "shippingPriceError" - # - "taxError" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" + # - "`customerInitiatedCancel`" + # - "`invalidCoupon`" + # - "`malformedShippingAddress`" + # - "`noInventory`" + # - "`other`" + # - "`priceError`" + # - "`shippingPriceError`" + # - "`taxError`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -6745,16 +6798,16 @@ module Google # The reason for the cancellation. # Acceptable values are: - # - "customerInitiatedCancel" - # - "invalidCoupon" - # - "malformedShippingAddress" - # - "noInventory" - # - "other" - # - "priceError" - # - "shippingPriceError" - # - "taxError" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" + # - "`customerInitiatedCancel`" + # - "`invalidCoupon`" + # - "`malformedShippingAddress`" + # - "`noInventory`" + # - "`other`" + # - "`priceError`" + # - "`shippingPriceError`" + # - "`taxError`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -6838,19 +6891,19 @@ module Google # The reason for the return. # Acceptable values are: - # - "customerDiscretionaryReturn" - # - "customerInitiatedMerchantCancel" - # - "deliveredTooLate" - # - "expiredItem" - # - "invalidCoupon" - # - "malformedShippingAddress" - # - "other" - # - "productArrivedDamaged" - # - "productNotAsDescribed" - # - "qualityNotAsExpected" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" - # - "wrongProductShipped" + # - "`customerDiscretionaryReturn`" + # - "`customerInitiatedMerchantCancel`" + # - "`deliveredTooLate`" + # - "`expiredItem`" + # - "`invalidCoupon`" + # - "`malformedShippingAddress`" + # - "`other`" + # - "`productArrivedDamaged`" + # - "`productNotAsDescribed`" + # - "`qualityNotAsExpected`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" + # - "`wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -6898,22 +6951,22 @@ module Google # The reason for the refund. # Acceptable values are: - # - "adjustment" - # - "courtesyAdjustment" - # - "customerCanceled" - # - "customerDiscretionaryReturn" - # - "deliveredLateByCarrier" - # - "feeAdjustment" - # - "lateShipmentCredit" - # - "noInventory" - # - "other" - # - "priceError" - # - "productArrivedDamaged" - # - "productNotAsDescribed" - # - "shippingCostAdjustment" - # - "taxAdjustment" - # - "undeliverableShippingAddress" - # - "wrongProductShipped" + # - "`adjustment`" + # - "`courtesyAdjustment`" + # - "`customerCanceled`" + # - "`customerDiscretionaryReturn`" + # - "`deliveredLateByCarrier`" + # - "`feeAdjustment`" + # - "`lateShipmentCredit`" + # - "`noInventory`" + # - "`other`" + # - "`priceError`" + # - "`productArrivedDamaged`" + # - "`productNotAsDescribed`" + # - "`shippingCostAdjustment`" + # - "`taxAdjustment`" + # - "`undeliverableShippingAddress`" + # - "`wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -6959,11 +7012,11 @@ module Google # The reason for the return. # Acceptable values are: - # - "damagedOrUsed" - # - "missingComponent" - # - "notEligible" - # - "other" - # - "outOfReturnWindow" + # - "`damagedOrUsed`" + # - "`missingComponent`" + # - "`notEligible`" + # - "`other`" + # - "`outOfReturnWindow`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -7009,19 +7062,19 @@ module Google # The reason for the return. # Acceptable values are: - # - "customerDiscretionaryReturn" - # - "customerInitiatedMerchantCancel" - # - "deliveredTooLate" - # - "expiredItem" - # - "invalidCoupon" - # - "malformedShippingAddress" - # - "other" - # - "productArrivedDamaged" - # - "productNotAsDescribed" - # - "qualityNotAsExpected" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" - # - "wrongProductShipped" + # - "`customerDiscretionaryReturn`" + # - "`customerInitiatedMerchantCancel`" + # - "`deliveredTooLate`" + # - "`expiredItem`" + # - "`invalidCoupon`" + # - "`malformedShippingAddress`" + # - "`other`" + # - "`productArrivedDamaged`" + # - "`productNotAsDescribed`" + # - "`qualityNotAsExpected`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" + # - "`wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -7080,19 +7133,19 @@ module Google # The reason for the return. # Acceptable values are: - # - "customerDiscretionaryReturn" - # - "customerInitiatedMerchantCancel" - # - "deliveredTooLate" - # - "expiredItem" - # - "invalidCoupon" - # - "malformedShippingAddress" - # - "other" - # - "productArrivedDamaged" - # - "productNotAsDescribed" - # - "qualityNotAsExpected" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" - # - "wrongProductShipped" + # - "`customerDiscretionaryReturn`" + # - "`customerInitiatedMerchantCancel`" + # - "`deliveredTooLate`" + # - "`expiredItem`" + # - "`invalidCoupon`" + # - "`malformedShippingAddress`" + # - "`other`" + # - "`productArrivedDamaged`" + # - "`productNotAsDescribed`" + # - "`qualityNotAsExpected`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" + # - "`wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -7156,8 +7209,8 @@ module Google include Google::Apis::Core::Hashable # Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. - # See shipments[].carrier in the Orders resource representation for a list of - # acceptable values. + # See `shipments[].carrier` in the Orders resource representation for a list + # of acceptable values. # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier @@ -7208,7 +7261,7 @@ module Google class OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo include Google::Apis::Core::Hashable - # The carrier handling the shipment. See shipments[].carrier in the Orders + # The carrier handling the shipment. See `shipments[].carrier` in the Orders # resource representation for a list of acceptable values. # Corresponds to the JSON property `carrier` # @return [String] @@ -7286,14 +7339,15 @@ module Google class OrdersCustomBatchRequestEntryUpdateShipment include Google::Apis::Core::Hashable - # The carrier handling the shipment. Not updated if missing. See shipments[]. - # carrier in the Orders resource representation for a list of acceptable values. + # The carrier handling the shipment. Not updated if missing. See `shipments[]. + # carrier` in the Orders resource representation for a list of acceptable + # values. # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier # Date on which the shipment has been delivered, in ISO 8601 format. Optional - # and can be provided only if status is delivered. + # and can be provided only if `status` is `delivered`. # Corresponds to the JSON property `deliveryDate` # @return [String] attr_accessor :delivery_date @@ -7305,8 +7359,8 @@ module Google # New status for the shipment. Not updated if missing. # Acceptable values are: - # - "delivered" - # - "undeliverable" + # - "`delivered`" + # - "`undeliverable`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -7372,22 +7426,24 @@ module Google # The status of the execution. Only defined if # - the request was successful; and - # - the method is not get, getByMerchantOrderId, or one of the test methods. + # - the method is not `get`, `getByMerchantOrderId`, or one of the test methods. + # # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status - # Identifies what kind of resource this is. Value: the fixed string "content# - # ordersCustomBatchResponseEntry". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # ordersCustomBatchResponseEntry`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Order. Production access (all methods) requires the order manager role. - # Sandbox access does not. + # Sandbox access does not. (== resource_for v2.orders ==) (== resource_for v2.1. + # orders ==) # Corresponds to the JSON property `order` # @return [Google::Apis::ContentV2::Order] attr_accessor :order @@ -7417,7 +7473,8 @@ module Google attr_accessor :kind # Order. Production access (all methods) requires the order manager role. - # Sandbox access does not. + # Sandbox access does not. (== resource_for v2.orders ==) (== resource_for v2.1. + # orders ==) # Corresponds to the JSON property `order` # @return [Google::Apis::ContentV2::Order] attr_accessor :order @@ -7496,19 +7553,19 @@ module Google # The reason for the return. # Acceptable values are: - # - "customerDiscretionaryReturn" - # - "customerInitiatedMerchantCancel" - # - "deliveredTooLate" - # - "expiredItem" - # - "invalidCoupon" - # - "malformedShippingAddress" - # - "other" - # - "productArrivedDamaged" - # - "productNotAsDescribed" - # - "qualityNotAsExpected" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" - # - "wrongProductShipped" + # - "`customerDiscretionaryReturn`" + # - "`customerInitiatedMerchantCancel`" + # - "`deliveredTooLate`" + # - "`expiredItem`" + # - "`invalidCoupon`" + # - "`malformedShippingAddress`" + # - "`other`" + # - "`productArrivedDamaged`" + # - "`productNotAsDescribed`" + # - "`qualityNotAsExpected`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" + # - "`wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -7541,8 +7598,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -7623,22 +7680,22 @@ module Google # The reason for the refund. # Acceptable values are: - # - "adjustment" - # - "courtesyAdjustment" - # - "customerCanceled" - # - "customerDiscretionaryReturn" - # - "deliveredLateByCarrier" - # - "feeAdjustment" - # - "lateShipmentCredit" - # - "noInventory" - # - "other" - # - "priceError" - # - "productArrivedDamaged" - # - "productNotAsDescribed" - # - "shippingCostAdjustment" - # - "taxAdjustment" - # - "undeliverableShippingAddress" - # - "wrongProductShipped" + # - "`adjustment`" + # - "`courtesyAdjustment`" + # - "`customerCanceled`" + # - "`customerDiscretionaryReturn`" + # - "`deliveredLateByCarrier`" + # - "`feeAdjustment`" + # - "`lateShipmentCredit`" + # - "`noInventory`" + # - "`other`" + # - "`priceError`" + # - "`productArrivedDamaged`" + # - "`productNotAsDescribed`" + # - "`shippingCostAdjustment`" + # - "`taxAdjustment`" + # - "`undeliverableShippingAddress`" + # - "`wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -7669,8 +7726,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -7719,11 +7776,11 @@ module Google # The reason for the return. # Acceptable values are: - # - "damagedOrUsed" - # - "missingComponent" - # - "notEligible" - # - "other" - # - "outOfReturnWindow" + # - "`damagedOrUsed`" + # - "`missingComponent`" + # - "`notEligible`" + # - "`other`" + # - "`outOfReturnWindow`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -7754,8 +7811,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -7804,19 +7861,19 @@ module Google # The reason for the return. # Acceptable values are: - # - "customerDiscretionaryReturn" - # - "customerInitiatedMerchantCancel" - # - "deliveredTooLate" - # - "expiredItem" - # - "invalidCoupon" - # - "malformedShippingAddress" - # - "other" - # - "productArrivedDamaged" - # - "productNotAsDescribed" - # - "qualityNotAsExpected" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" - # - "wrongProductShipped" + # - "`customerDiscretionaryReturn`" + # - "`customerInitiatedMerchantCancel`" + # - "`deliveredTooLate`" + # - "`expiredItem`" + # - "`invalidCoupon`" + # - "`malformedShippingAddress`" + # - "`other`" + # - "`productArrivedDamaged`" + # - "`productNotAsDescribed`" + # - "`qualityNotAsExpected`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" + # - "`wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -7847,8 +7904,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -7910,19 +7967,19 @@ module Google # The reason for the return. # Acceptable values are: - # - "customerDiscretionaryReturn" - # - "customerInitiatedMerchantCancel" - # - "deliveredTooLate" - # - "expiredItem" - # - "invalidCoupon" - # - "malformedShippingAddress" - # - "other" - # - "productArrivedDamaged" - # - "productNotAsDescribed" - # - "qualityNotAsExpected" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" - # - "wrongProductShipped" + # - "`customerDiscretionaryReturn`" + # - "`customerInitiatedMerchantCancel`" + # - "`deliveredTooLate`" + # - "`expiredItem`" + # - "`invalidCoupon`" + # - "`malformedShippingAddress`" + # - "`other`" + # - "`productArrivedDamaged`" + # - "`productNotAsDescribed`" + # - "`qualityNotAsExpected`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" + # - "`wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -7955,8 +8012,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -8023,8 +8080,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -8051,8 +8108,8 @@ module Google include Google::Apis::Core::Hashable # Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. - # See shipments[].carrier in the Orders resource representation for a list of - # acceptable values. + # See `shipments[].carrier` in the Orders resource representation for a list + # of acceptable values. # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier @@ -8111,8 +8168,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -8191,8 +8248,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -8245,8 +8302,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -8272,14 +8329,15 @@ module Google class OrdersUpdateShipmentRequest include Google::Apis::Core::Hashable - # The carrier handling the shipment. Not updated if missing. See shipments[]. - # carrier in the Orders resource representation for a list of acceptable values. + # The carrier handling the shipment. Not updated if missing. See `shipments[]. + # carrier` in the Orders resource representation for a list of acceptable + # values. # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier # Date on which the shipment has been delivered, in ISO 8601 format. Optional - # and can be provided only if status is delivered. + # and can be provided only if `status` is `delivered`. # Corresponds to the JSON property `deliveryDate` # @return [String] attr_accessor :delivery_date @@ -8296,8 +8354,8 @@ module Google # New status for the shipment. Not updated if missing. # Acceptable values are: - # - "delivered" - # - "undeliverable" + # - "`delivered`" + # - "`undeliverable`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -8328,8 +8386,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -8355,12 +8413,12 @@ module Google class PickupCarrierService include Google::Apis::Core::Hashable - # The name of the pickup carrier (e.g., "UPS"). Required. + # The name of the pickup carrier (e.g., `"UPS"`). Required. # Corresponds to the JSON property `carrierName` # @return [String] attr_accessor :carrier_name - # The name of the pickup service (e.g., "Access point"). Required. + # The name of the pickup service (e.g., `"Access point"`). Required. # Corresponds to the JSON property `serviceName` # @return [String] attr_accessor :service_name @@ -8380,7 +8438,7 @@ module Google class PickupServicesPickupService include Google::Apis::Core::Hashable - # The name of the carrier (e.g., "UPS"). Always present. + # The name of the carrier (e.g., `"UPS"`). Always present. # Corresponds to the JSON property `carrierName` # @return [String] attr_accessor :carrier_name @@ -8390,7 +8448,7 @@ module Google # @return [String] attr_accessor :country - # The name of the pickup service (e.g., "Access point"). Always present. + # The name of the pickup service (e.g., `"Access point"`). Always present. # Corresponds to the JSON property `serviceName` # @return [String] attr_accessor :service_name @@ -8447,11 +8505,11 @@ module Google # The method of the batch entry. # Acceptable values are: - # - "delete" - # - "get" - # - "insert" - # - "inventory" - # - "sale" + # - "`delete`" + # - "`get`" + # - "`insert`" + # - "`inventory`" + # - "`sale`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -8466,7 +8524,7 @@ module Google # @return [Google::Apis::ContentV2::PosStore] attr_accessor :store - # The store code. Set this only if the method is delete or get. + # The store code. Set this only if the method is `delete` or `get`. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code @@ -8538,8 +8596,8 @@ module Google # @return [Google::Apis::ContentV2::PosInventory] attr_accessor :inventory - # Identifies what kind of resource this is. Value: the fixed string "content# - # posCustomBatchResponseEntry". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # posCustomBatchResponseEntry`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -8644,8 +8702,8 @@ module Google # @return [String] attr_accessor :item_id - # Identifies what kind of resource this is. Value: the fixed string "content# - # posInventory". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # posInventory`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -8660,8 +8718,8 @@ module Google # @return [Fixnum] attr_accessor :quantity - # Required. The identifier of the merchant's store. Either a storeCode inserted - # via the API or the code of the store in Google My Business. + # Required. The identifier of the merchant's store. Either a `storeCode` + # inserted via the API or the code of the store in Google My Business. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code @@ -8723,8 +8781,8 @@ module Google # @return [Fixnum] attr_accessor :quantity - # Required. The identifier of the merchant's store. Either a storeCode inserted - # via the API or the code of the store in Google My Business. + # Required. The identifier of the merchant's store. Either a `storeCode` + # inserted via the API or the code of the store in Google My Business. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code @@ -8791,8 +8849,8 @@ module Google # @return [Fixnum] attr_accessor :quantity - # Required. The identifier of the merchant's store. Either a storeCode inserted - # via the API or the code of the store in Google My Business. + # Required. The identifier of the merchant's store. Either a `storeCode` + # inserted via the API or the code of the store in Google My Business. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code @@ -8870,8 +8928,8 @@ module Google # @return [String] attr_accessor :item_id - # Identifies what kind of resource this is. Value: the fixed string "content# - # posSale". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # posSale`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -8892,8 +8950,8 @@ module Google # @return [String] attr_accessor :sale_id - # Required. The identifier of the merchant's store. Either a storeCode inserted - # via the API or the code of the store in Google My Business. + # Required. The identifier of the merchant's store. Either a `storeCode` + # inserted via the API or the code of the store in Google My Business. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code @@ -8962,8 +9020,8 @@ module Google # @return [String] attr_accessor :sale_id - # Required. The identifier of the merchant's store. Either a storeCode inserted - # via the API or the code of the store in Google My Business. + # Required. The identifier of the merchant's store. Either a `storeCode` + # inserted via the API or the code of the store in Google My Business. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code @@ -9037,8 +9095,8 @@ module Google # @return [String] attr_accessor :sale_id - # Required. The identifier of the merchant's store. Either a storeCode inserted - # via the API or the code of the store in Google My Business. + # Required. The identifier of the merchant's store. Either a `storeCode` + # inserted via the API or the code of the store in Google My Business. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code @@ -9076,8 +9134,8 @@ module Google class PosStore include Google::Apis::Core::Hashable - # Identifies what kind of resource this is. Value: the fixed string "content# - # posStore". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # posStore`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -9140,20 +9198,20 @@ module Google class PostalCodeRange include Google::Apis::Core::Hashable - # A postal code or a pattern of the form prefix* denoting the inclusive lower - # bound of the range defining the area. Examples values: "94108", "9410*", "9*". - # Required. + # A postal code or a pattern of the form `prefix*` denoting the inclusive lower + # bound of the range defining the area. Examples values: `"94108"`, `"9410*"`, `" + # 9*"`. Required. # Corresponds to the JSON property `postalCodeRangeBegin` # @return [String] attr_accessor :postal_code_range_begin - # A postal code or a pattern of the form prefix* denoting the inclusive upper - # bound of the range defining the area. It must have the same length as - # postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then - # postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a - # pattern then postalCodeRangeEnd must be a pattern with the same prefix length. - # Optional: if not set, then the area is defined as being all the postal codes - # matching postalCodeRangeBegin. + # A postal code or a pattern of the form `prefix*` denoting the inclusive upper + # bound of the range defining the area. It must have the same length as ` + # postalCodeRangeBegin`: if `postalCodeRangeBegin` is a postal code then ` + # postalCodeRangeEnd` must be a postal code too; if `postalCodeRangeBegin` is a + # pattern then `postalCodeRangeEnd` must be a pattern with the same prefix + # length. Optional: if not set, then the area is defined as being all the postal + # codes matching `postalCodeRangeBegin`. # Corresponds to the JSON property `postalCodeRangeEnd` # @return [String] attr_accessor :postal_code_range_end @@ -9194,6 +9252,11 @@ module Google end end + # Required product attributes are primarily defined by the products data + # specification. See the Products Data Specification Help Center article for + # information. + # Some attributes are country-specific, so make sure you select the appropriate + # country in the drop-down selector at the top of the page. # Product data. After inserting, updating, or deleting a product, it may take # several minutes before changes take effect. class Product @@ -9234,12 +9297,12 @@ module Google # Target age group of the item. # Acceptable values are: - # - "adult" - # - "infant" - # - "kids" - # - "newborn" - # - "toddler" - # - "youngAdult" + # - "`adult`" + # - "`infant`" + # - "`kids`" + # - "`newborn`" + # - "`toddler`" + # - "`youngAdult`" # Corresponds to the JSON property `ageGroup` # @return [String] attr_accessor :age_group @@ -9251,9 +9314,9 @@ module Google # Availability status of the item. # Acceptable values are: - # - "in stock" - # - "out of stock" - # - "preorder" + # - "`in stock`" + # - "`out of stock`" + # - "`preorder`" # Corresponds to the JSON property `availability` # @return [String] attr_accessor :availability @@ -9271,8 +9334,8 @@ module Google # Required. The item's channel (online or local). # Acceptable values are: - # - "local" - # - "online" + # - "`local`" + # - "`online`" # Corresponds to the JSON property `channel` # @return [String] attr_accessor :channel @@ -9284,8 +9347,8 @@ module Google # Condition or state of the item. # Acceptable values are: - # - "local" - # - "online" + # - "`local`" + # - "`online`" # Corresponds to the JSON property `condition` # @return [String] attr_accessor :condition @@ -9302,7 +9365,7 @@ module Google # A list of custom (merchant-provided) attributes. It can also be used for # submitting any attribute of the feed specification in its generic form (e.g., ` - # "name": "size type", "value": "regular" `). This is useful for submitting + # ` "name": "size type", "value": "regular" ``). This is useful for submitting # attributes not explicitly exposed by the API, such as additional attributes # used for Shopping Actions. # Corresponds to the JSON property `customAttributes` @@ -9376,33 +9439,33 @@ module Google # The energy efficiency class as defined in EU directive 2010/30/EU. # Acceptable values are: - # - "A" - # - "A+" - # - "A++" - # - "A+++" - # - "B" - # - "C" - # - "D" - # - "E" - # - "F" - # - "G" + # - "`A`" + # - "`A+`" + # - "`A++`" + # - "`A+++`" + # - "`B`" + # - "`C`" + # - "`D`" + # - "`E`" + # - "`F`" + # - "`G`" # Corresponds to the JSON property `energyEfficiencyClass` # @return [String] attr_accessor :energy_efficiency_class # Date on which the item should expire, as specified upon insertion, in ISO 8601 - # format. The actual expiration date in Google Shopping is exposed in - # productstatuses as googleExpirationDate and might be earlier if expirationDate - # is too far in the future. + # format. The actual expiration date in Google Shopping is exposed in ` + # productstatuses` as `googleExpirationDate` and might be earlier if ` + # expirationDate` is too far in the future. # Corresponds to the JSON property `expirationDate` # @return [String] attr_accessor :expiration_date # Target gender of the item. # Acceptable values are: - # - "female" - # - "male" - # - "unisex" + # - "`female`" + # - "`male`" + # - "`unisex`" # Corresponds to the JSON property `gender` # @return [String] attr_accessor :gender @@ -9418,7 +9481,7 @@ module Google attr_accessor :gtin # The REST ID of the product. Content API methods that operate on products take - # this as their productId parameter. + # this as their `productId` parameter. # The REST ID for a product is of the form channel:contentLanguage:targetCountry: # offerId. # Corresponds to the JSON property `id` @@ -9455,8 +9518,8 @@ module Google # @return [String] attr_accessor :item_group_id - # Identifies what kind of resource this is. Value: the fixed string "content# - # product". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # product`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -9478,16 +9541,16 @@ module Google # The energy efficiency class as defined in EU directive 2010/30/EU. # Acceptable values are: - # - "A" - # - "A+" - # - "A++" - # - "A+++" - # - "B" - # - "C" - # - "D" - # - "E" - # - "F" - # - "G" + # - "`A`" + # - "`A+`" + # - "`A++`" + # - "`A+++`" + # - "`B`" + # - "`C`" + # - "`D`" + # - "`E`" + # - "`F`" + # - "`G`" # Corresponds to the JSON property `maxEnergyEfficiencyClass` # @return [String] attr_accessor :max_energy_efficiency_class @@ -9499,16 +9562,16 @@ module Google # The energy efficiency class as defined in EU directive 2010/30/EU. # Acceptable values are: - # - "A" - # - "A+" - # - "A++" - # - "A+++" - # - "B" - # - "C" - # - "D" - # - "E" - # - "F" - # - "G" + # - "`A`" + # - "`A+`" + # - "`A++`" + # - "`A+++`" + # - "`B`" + # - "`C`" + # - "`D`" + # - "`E`" + # - "`F`" + # - "`G`" # Corresponds to the JSON property `minEnergyEfficiencyClass` # @return [String] attr_accessor :min_energy_efficiency_class @@ -9543,7 +9606,7 @@ module Google # @return [String] attr_accessor :offer_id - # Deprecated. Whether an item is available for purchase only online. + # Deprecated. # Corresponds to the JSON property `onlineOnly` # @return [Boolean] attr_accessor :online_only @@ -9618,45 +9681,45 @@ module Google # System in which the size is specified. Recommended for apparel items. # Acceptable values are: - # - "AU" - # - "BR" - # - "CN" - # - "DE" - # - "EU" - # - "FR" - # - "IT" - # - "JP" - # - "MEX" - # - "UK" - # - "US" + # - "`AU`" + # - "`BR`" + # - "`CN`" + # - "`DE`" + # - "`EU`" + # - "`FR`" + # - "`IT`" + # - "`JP`" + # - "`MEX`" + # - "`UK`" + # - "`US`" # Corresponds to the JSON property `sizeSystem` # @return [String] attr_accessor :size_system # The cut of the item. Recommended for apparel items. # Acceptable values are: - # - "big and tall" - # - "maternity" - # - "oversize" - # - "petite" - # - "plus" - # - "regular" + # - "`big and tall`" + # - "`maternity`" + # - "`oversize`" + # - "`petite`" + # - "`plus`" + # - "`regular`" # Corresponds to the JSON property `sizeType` # @return [String] attr_accessor :size_type # Size of the item. Only one value is allowed. For variants with different sizes, - # insert a separate product for each size with the same itemGroupId value (see - # size definition). + # insert a separate product for each size with the same `itemGroupId` value ( + # see size definition). # Corresponds to the JSON property `sizes` # @return [Array] attr_accessor :sizes # The source of the offer, i.e., how the offer was created. # Acceptable values are: - # - "api" - # - "crawl" - # - "feed" + # - "`api`" + # - "`crawl`" + # - "`feed`" # Corresponds to the JSON property `source` # @return [String] attr_accessor :source @@ -9819,17 +9882,17 @@ module Google class ProductAspect include Google::Apis::Core::Hashable - # The name of the aspect. + # Deprecated. # Corresponds to the JSON property `aspectName` # @return [String] attr_accessor :aspect_name - # The name of the destination. Leave out to apply to all destinations. + # Deprecated. # Corresponds to the JSON property `destinationName` # @return [String] attr_accessor :destination_name - # Whether the aspect is required, excluded or should be validated. + # Deprecated. # Corresponds to the JSON property `intention` # @return [String] attr_accessor :intention @@ -9857,10 +9920,10 @@ module Google # Whether the destination is required, excluded or should be validated. # Acceptable values are: - # - "default" - # - "excluded" - # - "optional" - # - "required" + # - "`default`" + # - "`excluded`" + # - "`optional`" + # - "`required`" # Corresponds to the JSON property `intention` # @return [String] attr_accessor :intention @@ -10015,8 +10078,8 @@ module Google # @return [Array] attr_accessor :item_level_issues - # Identifies what kind of resource this is. Value: the fixed string "content# - # productStatus". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # productStatus`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -10031,6 +10094,11 @@ module Google # @return [String] attr_accessor :link + # Required product attributes are primarily defined by the products data + # specification. See the Products Data Specification Help Center article for + # information. + # Some attributes are country-specific, so make sure you select the appropriate + # country in the drop-down selector at the top of the page. # Product data. After inserting, updating, or deleting a product, it may take # several minutes before changes take effect. # Corresponds to the JSON property `product` @@ -10146,8 +10214,8 @@ module Google # The destination's approval status. # Acceptable values are: - # - "approved" - # - "disapproved" + # - "`approved`" + # - "`disapproved`" # Corresponds to the JSON property `approvalStatus` # @return [String] attr_accessor :approval_status @@ -10159,10 +10227,10 @@ module Google # Provided for backward compatibility only. Always set to "required". # Acceptable values are: - # - "default" - # - "excluded" - # - "optional" - # - "required" + # - "`default`" + # - "`excluded`" + # - "`optional`" + # - "`required`" # Corresponds to the JSON property `intention` # @return [String] attr_accessor :intention @@ -10379,21 +10447,26 @@ module Google # The method of the batch entry. # Acceptable values are: - # - "delete" - # - "get" - # - "insert" + # - "`delete`" + # - "`get`" + # - "`insert`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method + # Required product attributes are primarily defined by the products data + # specification. See the Products Data Specification Help Center article for + # information. + # Some attributes are country-specific, so make sure you select the appropriate + # country in the drop-down selector at the top of the page. # Product data. After inserting, updating, or deleting a product, it may take # several minutes before changes take effect. # Corresponds to the JSON property `product` # @return [Google::Apis::ContentV2::Product] attr_accessor :product - # The ID of the product to get or delete. Only defined if the method is get or - # delete. + # The ID of the product to get or delete. Only defined if the method is `get` or + # `delete`. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id @@ -10452,12 +10525,17 @@ module Google # @return [Google::Apis::ContentV2::Errors] attr_accessor :errors - # Identifies what kind of resource this is. Value: the fixed string "content# - # productsCustomBatchResponseEntry". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # productsCustomBatchResponseEntry`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind + # Required product attributes are primarily defined by the products data + # specification. See the Products Data Specification Help Center article for + # information. + # Some attributes are country-specific, so make sure you select the appropriate + # country in the drop-down selector at the top of the page. # Product data. After inserting, updating, or deleting a product, it may take # several minutes before changes take effect. # Corresponds to the JSON property `product` @@ -10556,7 +10634,7 @@ module Google # The method of the batch entry. # Acceptable values are: - # - "get" + # - "`get`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method @@ -10621,8 +10699,8 @@ module Google # @return [Google::Apis::ContentV2::Errors] attr_accessor :errors - # Identifies what kind of resource this is. Value: the fixed string "content# - # productstatusesCustomBatchResponseEntry". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # productstatusesCustomBatchResponseEntry`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -10716,13 +10794,14 @@ module Google # @return [Array] attr_accessor :applicable_shipping_labels - # A list of carrier rates that can be referred to by mainTable or singleValue. + # A list of carrier rates that can be referred to by `mainTable` or `singleValue` + # . # Corresponds to the JSON property `carrierRates` # @return [Array] attr_accessor :carrier_rates - # A table defining the rate group, when singleValue is not expressive enough. - # Can only be set if singleValue is not set. + # A table defining the rate group, when `singleValue` is not expressive enough. + # Can only be set if `singleValue` is not set. # Corresponds to the JSON property `mainTable` # @return [Google::Apis::ContentV2::Table] attr_accessor :main_table @@ -10734,14 +10813,14 @@ module Google attr_accessor :name # The single value of a rate group or the value of a rate group table's cell. - # Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, - # subtableName must be set. + # Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, + # `subtableName` must be set. # Corresponds to the JSON property `singleValue` # @return [Google::Apis::ContentV2::Value] attr_accessor :single_value - # A list of subtables referred to by mainTable. Can only be set if mainTable is - # set. + # A list of subtables referred to by `mainTable`. Can only be set if `mainTable` + # is set. # Corresponds to the JSON property `subtables` # @return [Array] attr_accessor :subtables @@ -10772,50 +10851,50 @@ module Google # Code of the refund reason. # Acceptable values are: - # - "adjustment" - # - "autoPostInternal" - # - "autoPostInvalidBillingAddress" - # - "autoPostNoInventory" - # - "autoPostPriceError" - # - "autoPostUndeliverableShippingAddress" - # - "couponAbuse" - # - "courtesyAdjustment" - # - "customerCanceled" - # - "customerDiscretionaryReturn" - # - "customerInitiatedMerchantCancel" - # - "customerSupportRequested" - # - "deliveredLateByCarrier" - # - "deliveredTooLate" - # - "expiredItem" - # - "failToPushOrderGoogleError" - # - "failToPushOrderMerchantError" - # - "failToPushOrderMerchantFulfillmentError" - # - "failToPushOrderToMerchant" - # - "failToPushOrderToMerchantOutOfStock" - # - "feeAdjustment" - # - "invalidCoupon" - # - "lateShipmentCredit" - # - "malformedShippingAddress" - # - "merchantDidNotShipOnTime" - # - "noInventory" - # - "orderTimeout" - # - "other" - # - "paymentAbuse" - # - "paymentDeclined" - # - "priceAdjustment" - # - "priceError" - # - "productArrivedDamaged" - # - "productNotAsDescribed" - # - "promoReallocation" - # - "qualityNotAsExpected" - # - "returnRefundAbuse" - # - "shippingCostAdjustment" - # - "shippingPriceError" - # - "taxAdjustment" - # - "taxError" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" - # - "wrongProductShipped" + # - "`adjustment`" + # - "`autoPostInternal`" + # - "`autoPostInvalidBillingAddress`" + # - "`autoPostNoInventory`" + # - "`autoPostPriceError`" + # - "`autoPostUndeliverableShippingAddress`" + # - "`couponAbuse`" + # - "`courtesyAdjustment`" + # - "`customerCanceled`" + # - "`customerDiscretionaryReturn`" + # - "`customerInitiatedMerchantCancel`" + # - "`customerSupportRequested`" + # - "`deliveredLateByCarrier`" + # - "`deliveredTooLate`" + # - "`expiredItem`" + # - "`failToPushOrderGoogleError`" + # - "`failToPushOrderMerchantError`" + # - "`failToPushOrderMerchantFulfillmentError`" + # - "`failToPushOrderToMerchant`" + # - "`failToPushOrderToMerchantOutOfStock`" + # - "`feeAdjustment`" + # - "`invalidCoupon`" + # - "`lateShipmentCredit`" + # - "`malformedShippingAddress`" + # - "`merchantDidNotShipOnTime`" + # - "`noInventory`" + # - "`orderTimeout`" + # - "`other`" + # - "`paymentAbuse`" + # - "`paymentDeclined`" + # - "`priceAdjustment`" + # - "`priceError`" + # - "`productArrivedDamaged`" + # - "`productNotAsDescribed`" + # - "`promoReallocation`" + # - "`qualityNotAsExpected`" + # - "`returnRefundAbuse`" + # - "`shippingCostAdjustment`" + # - "`shippingPriceError`" + # - "`taxAdjustment`" + # - "`taxError`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" + # - "`wrongProductShipped`" # Corresponds to the JSON property `reasonCode` # @return [String] attr_accessor :reason_code @@ -10847,9 +10926,9 @@ module Google # Type of the return method. # Acceptable values are: - # - "byMail" - # - "contactCustomerSupport" - # - "returnless" + # - "`byMail`" + # - "`contactCustomerSupport`" + # - "`returnless`" # Corresponds to the JSON property `returnMethodType` # @return [String] attr_accessor :return_method_type @@ -10872,10 +10951,10 @@ module Google # State of the shipment. # Acceptable values are: - # - "completed" - # - "new" - # - "shipped" - # - "undeliverable" + # - "`completed`" + # - "`new`" + # - "`shipped`" + # - "`undeliverable`" # Corresponds to the JSON property `state` # @return [String] attr_accessor :state @@ -10900,8 +10979,8 @@ module Google class Row include Google::Apis::Core::Hashable - # The list of cells that constitute the row. Must have the same length as - # columnHeaders for two-dimensional tables, a length of 1 for one-dimensional + # The list of cells that constitute the row. Must have the same length as ` + # columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional # tables. Required. # Corresponds to the JSON property `cells` # @return [Array] @@ -10946,43 +11025,49 @@ module Google # Eligibility for this service. # Acceptable values are: - # - "All scenarios" - # - "All scenarios except Shopping Actions" - # - "Shopping Actions" + # - "`All scenarios`" + # - "`All scenarios except Shopping Actions`" + # - "`Shopping Actions`" # Corresponds to the JSON property `eligibility` # @return [String] attr_accessor :eligibility # Minimum order value for this service. If set, indicates that customers will # have to spend at least this amount. All prices within a service must have the - # same currency. + # same currency. Cannot be set together with minimum_order_value_table. # Corresponds to the JSON property `minimumOrderValue` # @return [Google::Apis::ContentV2::Price] attr_accessor :minimum_order_value + # Table of per store minimum order values for the pickup fulfillment type. + # Cannot be set together with minimum_order_value. + # Corresponds to the JSON property `minimumOrderValueTable` + # @return [Google::Apis::ContentV2::MinimumOrderValueTable] + attr_accessor :minimum_order_value_table + # Free-form name of the service. Must be unique within target account. Required. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The carrier-service pair delivering items to collection points. The list of - # supported pickup services can be retrieved via the getSupportedPickupServices - # method. Required if and only if the service delivery type is pickup. + # supported pickup services can be retrieved via the `getSupportedPickupServices` + # method. Required if and only if the service delivery type is `pickup`. # Corresponds to the JSON property `pickupService` # @return [Google::Apis::ContentV2::PickupCarrierService] attr_accessor :pickup_service # Shipping rate group definitions. Only the last one is allowed to have an empty - # applicableShippingLabels, which means "everything else". The other - # applicableShippingLabels must not overlap. + # `applicableShippingLabels`, which means "everything else". The other ` + # applicableShippingLabels` must not overlap. # Corresponds to the JSON property `rateGroups` # @return [Array] attr_accessor :rate_groups # Type of locations this service ships orders to. # Acceptable values are: - # - "delivery" - # - "pickup" + # - "`delivery`" + # - "`pickup`" # Corresponds to the JSON property `shipmentType` # @return [String] attr_accessor :shipment_type @@ -10999,6 +11084,7 @@ module Google @delivery_time = args[:delivery_time] if args.key?(:delivery_time) @eligibility = args[:eligibility] if args.key?(:eligibility) @minimum_order_value = args[:minimum_order_value] if args.key?(:minimum_order_value) + @minimum_order_value_table = args[:minimum_order_value_table] if args.key?(:minimum_order_value_table) @name = args[:name] if args.key?(:name) @pickup_service = args[:pickup_service] if args.key?(:pickup_service) @rate_groups = args[:rate_groups] if args.key?(:rate_groups) @@ -11020,8 +11106,8 @@ module Google # @return [Array] attr_accessor :line_item_invoices - # [required] ID of the shipment group. It is assigned by the merchant in the - # shipLineItems method and is used to group multiple line items that have the + # [required] ID of the shipment group. It is assigned by the merchant in the ` + # shipLineItems` method and is used to group multiple line items that have the # same kind of shipping charges. # Corresponds to the JSON property `shipmentGroupId` # @return [String] @@ -11086,36 +11172,36 @@ module Google # The shipping carrier that handles the package. # Acceptable values are: - # - "boxtal" - # - "bpost" - # - "chronopost" - # - "colisPrive" - # - "colissimo" - # - "cxt" - # - "deliv" - # - "dhl" - # - "dpd" - # - "dynamex" - # - "eCourier" - # - "easypost" - # - "efw" - # - "fedex" - # - "fedexSmartpost" - # - "geodis" - # - "gls" - # - "googleCourier" - # - "gsx" - # - "jdLogistics" - # - "laPoste" - # - "lasership" - # - "manual" - # - "mpx" - # - "onTrac" - # - "other" - # - "tnt" - # - "uds" - # - "ups" - # - "usps" + # - "`boxtal`" + # - "`bpost`" + # - "`chronopost`" + # - "`colisPrive`" + # - "`colissimo`" + # - "`cxt`" + # - "`deliv`" + # - "`dhl`" + # - "`dpd`" + # - "`dynamex`" + # - "`eCourier`" + # - "`easypost`" + # - "`efw`" + # - "`fedex`" + # - "`fedexSmartpost`" + # - "`geodis`" + # - "`gls`" + # - "`googleCourier`" + # - "`gsx`" + # - "`jdLogistics`" + # - "`laPoste`" + # - "`lasership`" + # - "`manual`" + # - "`mpx`" + # - "`onTrac`" + # - "`other`" + # - "`tnt`" + # - "`uds`" + # - "`ups`" + # - "`usps`" # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier @@ -11147,7 +11233,7 @@ module Google # @return [Fixnum] attr_accessor :account_id - # A list of postal code groups that can be referred to in services. Optional. + # A list of postal code groups that can be referred to in `services`. Optional. # Corresponds to the JSON property `postalCodeGroups` # @return [Array] attr_accessor :postal_code_groups @@ -11209,8 +11295,8 @@ module Google # The method of the batch entry. # Acceptable values are: - # - "get" - # - "update" + # - "`get`" + # - "`update`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -11275,8 +11361,8 @@ module Google # @return [Google::Apis::ContentV2::Errors] attr_accessor :errors - # Identifies what kind of resource this is. Value: the fixed string "content# - # shippingsettingsCustomBatchResponseEntry". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # shippingsettingsCustomBatchResponseEntry`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -11414,8 +11500,8 @@ module Google class Table include Google::Apis::Core::Hashable - # A non-empty list of row or column headers for a table. Exactly one of prices, - # weights, numItems, postalCodeGroupNames, or location must be set. + # A non-empty list of row or column headers for a table. Exactly one of `prices`, + # `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Corresponds to the JSON property `columnHeaders` # @return [Google::Apis::ContentV2::Headers] attr_accessor :column_headers @@ -11425,14 +11511,14 @@ module Google # @return [String] attr_accessor :name - # A non-empty list of row or column headers for a table. Exactly one of prices, - # weights, numItems, postalCodeGroupNames, or location must be set. + # A non-empty list of row or column headers for a table. Exactly one of `prices`, + # `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Corresponds to the JSON property `rowHeaders` # @return [Google::Apis::ContentV2::Headers] attr_accessor :row_headers - # The list of rows that constitute the table. Must have the same length as - # rowHeaders. Required. + # The list of rows that constitute the table. Must have the same length as ` + # rowHeaders`. Required. # Corresponds to the JSON property `rows` # @return [Array] attr_accessor :rows @@ -11465,8 +11551,8 @@ module Google attr_accessor :enable_orderinvoices alias_method :enable_orderinvoices?, :enable_orderinvoices - # Identifies what kind of resource this is. Value: the fixed string "content# - # testOrder". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # testOrder`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -11476,11 +11562,7 @@ module Google # @return [Array] attr_accessor :line_items - # Determines if test order must be pulled by merchant or pushed to merchant via - # push integration. - # Acceptable values are: - # - "checkoutIntegration" - # - "merchantPull" + # Restricted. Do not use. # Corresponds to the JSON property `notificationMode` # @return [String] attr_accessor :notification_mode @@ -11493,19 +11575,19 @@ module Google # Required. Identifier of one of the predefined delivery addresses for the # delivery. # Acceptable values are: - # - "dwight" - # - "jim" - # - "pam" + # - "`dwight`" + # - "`jim`" + # - "`pam`" # Corresponds to the JSON property `predefinedDeliveryAddress` # @return [String] attr_accessor :predefined_delivery_address # Identifier of one of the predefined pickup details. Required for orders - # containing line items with shipping type pickup. + # containing line items with shipping type `pickup`. # Acceptable values are: - # - "dwight" - # - "jim" - # - "pam" + # - "`dwight`" + # - "`jim`" + # - "`pam`" # Corresponds to the JSON property `predefinedPickupDetails` # @return [String] attr_accessor :predefined_pickup_details @@ -11530,12 +11612,12 @@ module Google # Required. The requested shipping option. # Acceptable values are: - # - "economy" - # - "expedited" - # - "oneDay" - # - "sameDay" - # - "standard" - # - "twoDay" + # - "`economy`" + # - "`expedited`" + # - "`oneDay`" + # - "`sameDay`" + # - "`standard`" + # - "`twoDay`" # Corresponds to the JSON property `shippingOption` # @return [String] attr_accessor :shipping_option @@ -11567,9 +11649,9 @@ module Google # Required. Email address of the customer. # Acceptable values are: - # - "pog.dwight.schrute@gmail.com" - # - "pog.jim.halpert@gmail.com" - # - "penpog.pam.beesly@gmail.comding" + # - "`pog.dwight.schrute@gmail.com`" + # - "`pog.jim.halpert@gmail.com`" + # - "`penpog.pam.beesly@gmail.comding`" # Corresponds to the JSON property `email` # @return [String] attr_accessor :email @@ -11610,8 +11692,8 @@ module Google # Last know user use selection regards marketing preferences. In certain cases # selection might not be known, so this field would be empty. # Acceptable values are: - # - "denied" - # - "granted" + # - "`denied`" + # - "`granted`" # Corresponds to the JSON property `explicitMarketingPreference` # @return [String] attr_accessor :explicit_marketing_preference @@ -11687,22 +11769,22 @@ module Google # Deprecated. # Acceptable values are: - # - "online" + # - "`online`" # Corresponds to the JSON property `channel` # @return [String] attr_accessor :channel # Required. Condition or state of the item. # Acceptable values are: - # - "new" + # - "`new`" # Corresponds to the JSON property `condition` # @return [String] attr_accessor :condition # Required. The two-letter ISO 639-1 language code for the item. # Acceptable values are: - # - "en" - # - "fr" + # - "`en`" + # - "`fr`" # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language @@ -11803,20 +11885,20 @@ module Google # The billing address. # Acceptable values are: - # - "dwight" - # - "jim" - # - "pam" + # - "`dwight`" + # - "`jim`" + # - "`pam`" # Corresponds to the JSON property `predefinedBillingAddress` # @return [String] attr_accessor :predefined_billing_address # The type of instrument. Note that real orders might have different values than - # the four values accepted by createTestOrder. + # the four values accepted by `createTestOrder`. # Acceptable values are: - # - "AMEX" - # - "DISCOVER" - # - "MASTERCARD" - # - "VISA" + # - "`AMEX`" + # - "`DISCOVER`" + # - "`MASTERCARD`" + # - "`VISA`" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -11839,9 +11921,9 @@ module Google class TransitTable include Google::Apis::Core::Hashable - # A list of postal group names. The last value can be "all other locations". - # Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code - # groups must match the delivery country of the service. + # A list of postal group names. The last value can be `"all other locations"`. + # Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal + # code groups must match the delivery country of the service. # Corresponds to the JSON property `postalCodeGroupNames` # @return [Array] attr_accessor :postal_code_group_names @@ -11851,8 +11933,8 @@ module Google # @return [Array] attr_accessor :rows - # A list of transit time labels. The last value can be "all other labels". - # Example: ["food", "electronics", "all other labels"]. + # A list of transit time labels. The last value can be `"all other labels"`. + # Example: `["food", "electronics", "all other labels"]`. # Corresponds to the JSON property `transitTimeLabels` # @return [Array] attr_accessor :transit_time_labels @@ -11892,7 +11974,7 @@ module Google class TransitTableTransitTimeRowTransitTimeValue include Google::Apis::Core::Hashable - # Must be greater than or equal to minTransitTimeInDays. + # Must be greater than or equal to `minTransitTimeInDays`. # Corresponds to the JSON property `maxTransitTimeInDays` # @return [Fixnum] attr_accessor :max_transit_time_in_days @@ -11967,7 +12049,7 @@ module Google # [required] Type of the additional charge. # Acceptable values are: - # - "shipping" + # - "`shipping`" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -11993,17 +12075,17 @@ module Google # @return [Google::Apis::ContentV2::Price] attr_accessor :tax_amount - # Optional name of the tax type. This should only be provided if taxType is - # otherFeeTax. + # Optional name of the tax type. This should only be provided if `taxType` is ` + # otherFeeTax`. # Corresponds to the JSON property `taxName` # @return [String] attr_accessor :tax_name # [required] Type of the tax. # Acceptable values are: - # - "otherFee" - # - "otherFeeTax" - # - "sales" + # - "`otherFee`" + # - "`otherFeeTax`" + # - "`sales`" # Corresponds to the JSON property `taxType` # @return [String] attr_accessor :tax_type @@ -12021,8 +12103,8 @@ module Google end # The single value of a rate group or the value of a rate group table's cell. - # Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, - # subtableName must be set. + # Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, + # `subtableName` must be set. class Value include Google::Apis::Core::Hashable @@ -12044,8 +12126,8 @@ module Google attr_accessor :no_shipping alias_method :no_shipping?, :no_shipping - # A percentage of the price represented as a number in decimal notation (e.g., " - # 5.4"). Can only be set if all other fields are not set. + # A percentage of the price represented as a number in decimal notation (e.g., `" + # 5.4"`). Can only be set if all other fields are not set. # Corresponds to the JSON property `pricePercentage` # @return [String] attr_accessor :price_percentage @@ -12076,8 +12158,8 @@ module Google # Required. The weight unit. # Acceptable values are: - # - "kg" - # - "lb" + # - "`kg`" + # - "`lb`" # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit diff --git a/generated/google/apis/content_v2/representations.rb b/generated/google/apis/content_v2/representations.rb index 74eae350d..5a0367c59 100644 --- a/generated/google/apis/content_v2/representations.rb +++ b/generated/google/apis/content_v2/representations.rb @@ -646,6 +646,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class MinimumOrderValueTable + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MinimumOrderValueTableStoreCodeSetWithMov + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Order class Representation < Google::Apis::Core::JsonRepresentation; end @@ -2760,6 +2772,23 @@ module Google end end + class MinimumOrderValueTable + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :store_code_set_with_movs, as: 'storeCodeSetWithMovs', class: Google::Apis::ContentV2::MinimumOrderValueTableStoreCodeSetWithMov, decorator: Google::Apis::ContentV2::MinimumOrderValueTableStoreCodeSetWithMov::Representation + + end + end + + class MinimumOrderValueTableStoreCodeSetWithMov + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :store_codes, as: 'storeCodes' + property :value, as: 'value', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation + + end + end + class Order # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -4398,6 +4427,8 @@ module Google property :eligibility, as: 'eligibility' property :minimum_order_value, as: 'minimumOrderValue', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation + property :minimum_order_value_table, as: 'minimumOrderValueTable', class: Google::Apis::ContentV2::MinimumOrderValueTable, decorator: Google::Apis::ContentV2::MinimumOrderValueTable::Representation + property :name, as: 'name' property :pickup_service, as: 'pickupService', class: Google::Apis::ContentV2::PickupCarrierService, decorator: Google::Apis::ContentV2::PickupCarrierService::Representation diff --git a/generated/google/apis/content_v2/service.rb b/generated/google/apis/content_v2/service.rb index 25c7e8f0b..e025e1cb0 100644 --- a/generated/google/apis/content_v2/service.rb +++ b/generated/google/apis/content_v2/service.rb @@ -85,13 +85,13 @@ module Google # Claims the website of a Merchant Center sub-account. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account whose website is claimed. # @param [Boolean] overwrite - # Only available to selected merchants. When set to True, this flag removes any - # existing claim on the requested website by another account and replaces it + # Only available to selected merchants. When set to `True`, this flag removes + # any existing claim on the requested website by another account and replaces it # with a claim from this account. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -208,8 +208,8 @@ module Google # Retrieves a Merchant Center account. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account. # @param [String] fields @@ -287,8 +287,8 @@ module Google # accountId and linkedAccountId. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account that should be linked. # @param [Google::Apis::ContentV2::AccountsLinkRequest] accounts_link_request_object @@ -367,8 +367,8 @@ module Google # Updates a Merchant Center account. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account. # @param [Google::Apis::ContentV2::Account] account_object @@ -446,8 +446,8 @@ module Google # returned for multi-client accounts. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account. # @param [Array, String] destinations @@ -569,8 +569,8 @@ module Google # Retrieves the tax settings of the account. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which to get/update account tax settings. # @param [String] fields @@ -646,8 +646,8 @@ module Google # Updates the tax settings of the account. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which to get/update account tax settings. # @param [Google::Apis::ContentV2::AccountTax] account_tax_object @@ -1133,7 +1133,7 @@ module Google # The ID of the account that contains the product. This account cannot be a # multi-client account. # @param [String] store_code - # The code of the store for which to update price and availability. Use online + # The code of the store for which to update price and availability. Use `online` # to update price and availability of an online product. # @param [String] product_id # The REST ID of the product for which to update price and availability. @@ -1217,8 +1217,8 @@ module Google # Retrieves the LIA settings of the account. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which to get or update LIA settings. # @param [String] fields @@ -1255,8 +1255,8 @@ module Google # Retrieves the list of accessible Google My Business accounts. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which to retrieve accessible Google My Business # accounts. @@ -1364,8 +1364,8 @@ module Google # Requests access to a specified Google My Business account. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which GMB access is requested. # @param [String] gmb_email @@ -1405,8 +1405,8 @@ module Google # Requests inventory validation for the specified country. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account that manages the order. This cannot be a multi-client # account. @@ -1447,8 +1447,8 @@ module Google # Sets the inventory verification contract for the specified country. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account that manages the order. This cannot be a multi-client # account. @@ -1498,8 +1498,8 @@ module Google # Sets the POS data provider for the specified country. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which to retrieve accessible Google My Business # accounts. @@ -1546,8 +1546,8 @@ module Google # Updates the LIA settings of the account. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which to get or update LIA settings. # @param [Google::Apis::ContentV2::LiaSettings] lia_settings_object @@ -1631,7 +1631,7 @@ module Google # Creates a refund invoice for one or more shipment groups, and triggers a # refund for orderinvoice enabled orders. This can only be used for line items - # that have previously been charged using createChargeInvoice. All amounts ( + # that have previously been charged using `createChargeInvoice`. All amounts ( # except for the summary) are incremental with respect to the previous invoice. # @param [Fixnum] merchant_id # The ID of the account that manages the order. This cannot be a multi-client @@ -1900,8 +1900,8 @@ module Google execute_or_queue_command(command, &block) end - # Sandbox only. Moves a test order from state "inProgress" to state " - # pendingShipment". + # Sandbox only. Moves a test order from state "`inProgress`" to state "` + # pendingShipment`". # @param [Fixnum] merchant_id # The ID of the account that manages the order. This cannot be a multi-client # account. @@ -2250,7 +2250,7 @@ module Google # @param [String] template_name # The name of the template to retrieve. # @param [String] country - # The country of the template to retrieve. Defaults to US. + # The country of the template to retrieve. Defaults to `US`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2339,8 +2339,8 @@ module Google # Obtains orders that match the acknowledgement status. When set to true, # obtains orders that have been acknowledged. When false, obtains orders that # have not been acknowledged. - # We recommend using this filter set to false, in conjunction with the - # acknowledge call, such that only un-acknowledged orders are returned. + # We recommend using this filter set to `false`, in conjunction with the ` + # acknowledge` call, such that only un-acknowledged orders are returned. # @param [Fixnum] max_results # The maximum number of orders to return in the response, used for paging. The # default value is 25 orders per page, and the maximum allowed value is 250 @@ -2357,10 +2357,10 @@ module Google # @param [String] placed_date_start # Obtains orders placed after this date (inclusively), in ISO 8601 format. # @param [Array, String] statuses - # Obtains orders that match any of the specified statuses. Please note that - # active is a shortcut for pendingShipment and partiallyShipped, and completed - # is a shortcut for shipped, partiallyDelivered, delivered, partiallyReturned, - # returned, and canceled. + # Obtains orders that match any of the specified statuses. Please note that ` + # active` is a shortcut for `pendingShipment` and `partiallyShipped`, and ` + # completed` is a shortcut for `shipped`, `partiallyDelivered`, `delivered`, ` + # partiallyReturned`, `returned`, and `canceled`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3423,8 +3423,8 @@ module Google # Retrieves the shipping settings of the account. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which to get/update shipping settings. # @param [String] fields @@ -3601,8 +3601,8 @@ module Google # Updates the shipping settings of the account. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which to get/update shipping settings. # @param [Google::Apis::ContentV2::ShippingSettings] shipping_settings_object diff --git a/generated/google/apis/content_v2_1.rb b/generated/google/apis/content_v2_1.rb index 24f23e9b4..ad0ba2bb3 100644 --- a/generated/google/apis/content_v2_1.rb +++ b/generated/google/apis/content_v2_1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/shopping-content module ContentV2_1 VERSION = 'V2_1' - REVISION = '20200310' + REVISION = '20200421' # Manage your product listings and accounts for Google Shopping AUTH_CONTENT = 'https://www.googleapis.com/auth/content' diff --git a/generated/google/apis/content_v2_1/classes.rb b/generated/google/apis/content_v2_1/classes.rb index 78c919d9e..d5ceaf9b2 100644 --- a/generated/google/apis/content_v2_1/classes.rb +++ b/generated/google/apis/content_v2_1/classes.rb @@ -29,8 +29,8 @@ module Google include Google::Apis::Core::Hashable # List of linked Ads accounts that are active or pending approval. To create a - # new link request, add a new link with status active to the list. It will - # remain in a pending state until approved or rejected either in the Ads + # new link request, add a new link with status `active` to the list. It will + # remain in a `pending` state until approved or rejected either in the Ads # interface or through the AdWords API. To delete an active link, or to cancel a # link request, remove it from the list. # Corresponds to the JSON property `adsLinks` @@ -59,8 +59,8 @@ module Google # @return [Fixnum] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string "content# - # account". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # account`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -87,10 +87,10 @@ module Google attr_accessor :website_url # List of linked YouTube channels that are active or pending approval. To create - # a new link request, add a new link with status active to the list. It will - # remain in a pending state until approved or rejected in the YT Creator Studio - # interface. To delete an active link, or to cancel a link request, remove it - # from the list. + # a new link request, add a new link with status `active` to the list. It will + # remain in a `pending` state until approved or rejected in the YT Creator + # Studio interface. To delete an active link, or to cancel a link request, + # remove it from the list. # Corresponds to the JSON property `youtubeChannelLinks` # @return [Array] attr_accessor :youtube_channel_links @@ -170,17 +170,17 @@ module Google attr_accessor :ads_id # Status of the link between this Merchant Center account and the Ads account. - # Upon retrieval, it represents the actual status of the link and can be either - # active if it was approved in Google Ads or pending if it's pending approval. + # Upon retrieval, it represents the actual status of the link and can be either ` + # active` if it was approved in Google Ads or `pending` if it's pending approval. # Upon insertion, it represents the intended status of the link. Re-uploading a - # link with status active when it's still pending or with status pending when it' - # s already active will have no effect: the status will remain unchanged. Re- - # uploading a link with deprecated status inactive is equivalent to not + # link with status `active` when it's still pending or with status `pending` + # when it's already active will have no effect: the status will remain unchanged. + # Re-uploading a link with deprecated status `inactive` is equivalent to not # submitting the link at all and will delete the link if it was active or cancel # the link request if it was pending. # Acceptable values are: - # - "active" - # - "pending" + # - "`active`" + # - "`pending`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -262,6 +262,12 @@ module Google class AccountGoogleMyBusinessLink include Google::Apis::Core::Hashable + # The ID of the GMB account. If this is provided, then `gmbEmail` is ignored. + # The value of this field should match the `accountId` used by the GMB API. + # Corresponds to the JSON property `gmbAccountId` + # @return [String] + attr_accessor :gmb_account_id + # The GMB email address of which a specific account within a GMB account. A # sample account within a GMB account could be a business account with set of # locations, managed under the GMB account. @@ -271,8 +277,8 @@ module Google # Status of the link between this Merchant Center account and the GMB account. # Acceptable values are: - # - "active" - # - "pending" + # - "`active`" + # - "`pending`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -283,6 +289,7 @@ module Google # Update properties of this object def update!(**args) + @gmb_account_id = args[:gmb_account_id] if args.key?(:gmb_account_id) @gmb_email = args[:gmb_email] if args.key?(:gmb_email) @status = args[:status] if args.key?(:status) end @@ -329,8 +336,8 @@ module Google # @return [Array] attr_accessor :account_level_issues - # Identifies what kind of resource this is. Value: the fixed string "content# - # accountStatus". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # accountStatus`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -392,9 +399,9 @@ module Google # Severity of the issue. # Acceptable values are: - # - "critical" - # - "error" - # - "suggestion" + # - "`critical`" + # - "`error`" + # - "`suggestion`" # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity @@ -487,8 +494,8 @@ module Google # The channel the data applies to. # Acceptable values are: - # - "local" - # - "online" + # - "`local`" + # - "`online`" # Corresponds to the JSON property `channel` # @return [String] attr_accessor :channel @@ -702,11 +709,11 @@ module Google # Status of the link between this Merchant Center account and the YouTube # channel. Upon retrieval, it represents the actual status of the link and can - # be either active if it was approved in YT Creator Studio or pending if it's - # pending approval. Upon insertion, it represents the intended status of the - # link. Re-uploading a link with status active when it's still pending or with - # status pending when it's already active will have no effect: the status will - # remain unchanged. Re-uploading a link with deprecated status inactive is + # be either `active` if it was approved in YT Creator Studio or `pending` if it' + # s pending approval. Upon insertion, it represents the intended status of the + # link. Re-uploading a link with status `active` when it's still pending or with + # status `pending` when it's already active will have no effect: the status will + # remain unchanged. Re-uploading a link with deprecated status `inactive` is # equivalent to not submitting the link at all and will delete the link if it # was active or cancel the link request if it was pending. # Corresponds to the JSON property `status` @@ -804,7 +811,7 @@ module Google # @return [Google::Apis::ContentV2_1::Account] attr_accessor :account - # The ID of the targeted account. Only defined if the method is not insert. + # The ID of the targeted account. Only defined if the method is not `insert`. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id @@ -815,13 +822,13 @@ module Google attr_accessor :batch_id # Whether the account should be deleted if the account has offers. Only - # applicable if the method is delete. + # applicable if the method is `delete`. # Corresponds to the JSON property `force` # @return [Boolean] attr_accessor :force alias_method :force?, :force - # Details about the link request. + # Details about the `link` request. # Corresponds to the JSON property `linkRequest` # @return [Google::Apis::ContentV2_1::AccountsCustomBatchRequestEntryLinkRequest] attr_accessor :link_request @@ -833,17 +840,17 @@ module Google # The method of the batch entry. # Acceptable values are: - # - "claimWebsite" - # - "delete" - # - "get" - # - "insert" - # - "link" - # - "update" + # - "`claimWebsite`" + # - "`delete`" + # - "`get`" + # - "`insert`" + # - "`link`" + # - "`update`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop - # Only applicable if the method is claimwebsite. Indicates whether or not to + # Only applicable if the method is `claimwebsite`. Indicates whether or not to # take the claim from another account in case there is a conflict. # Corresponds to the JSON property `overwrite` # @return [Boolean] @@ -871,20 +878,20 @@ module Google class AccountsCustomBatchRequestEntryLinkRequest include Google::Apis::Core::Hashable - # Action to perform for this link. The "request" action is only available to + # Action to perform for this link. The `"request"` action is only available to # select merchants. # Acceptable values are: - # - "approve" - # - "remove" - # - "request" + # - "`approve`" + # - "`remove`" + # - "`request`" # Corresponds to the JSON property `action` # @return [String] attr_accessor :action # Type of the link between the two accounts. # Acceptable values are: - # - "channelPartner" - # - "eCommercePlatform" + # - "`channelPartner`" + # - "`eCommercePlatform`" # Corresponds to the JSON property `linkType` # @return [String] attr_accessor :link_type @@ -959,8 +966,8 @@ module Google # @return [Google::Apis::ContentV2_1::Errors] attr_accessor :errors - # Identifies what kind of resource this is. Value: the fixed string "content# - # accountsCustomBatchResponseEntry". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # accountsCustomBatchResponseEntry`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -982,20 +989,20 @@ module Google class AccountsLinkRequest include Google::Apis::Core::Hashable - # Action to perform for this link. The "request" action is only available to + # Action to perform for this link. The `"request"` action is only available to # select merchants. # Acceptable values are: - # - "approve" - # - "remove" - # - "request" + # - "`approve`" + # - "`remove`" + # - "`request`" # Corresponds to the JSON property `action` # @return [String] attr_accessor :action # Type of the link between the two accounts. # Acceptable values are: - # - "channelPartner" - # - "eCommercePlatform" + # - "`channelPartner`" + # - "`eCommercePlatform`" # Corresponds to the JSON property `linkType` # @return [String] attr_accessor :link_type @@ -1153,7 +1160,7 @@ module Google # The method of the batch entry. # Acceptable values are: - # - "get" + # - "`get`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -1307,8 +1314,8 @@ module Google # The method of the batch entry. # Acceptable values are: - # - "get" - # - "update" + # - "`get`" + # - "`update`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -1372,8 +1379,8 @@ module Google # @return [Google::Apis::ContentV2_1::Errors] attr_accessor :errors - # Identifies what kind of resource this is. Value: the fixed string "content# - # accounttaxCustomBatchResponseEntry". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # accounttaxCustomBatchResponseEntry`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1472,21 +1479,22 @@ module Google class CarrierRate include Google::Apis::Core::Hashable - # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can - # be retrieved via the getSupportedCarriers method. Required. + # Carrier service, such as `"UPS"` or `"Fedex"`. The list of supported carriers + # can be retrieved via the `getSupportedCarriers` method. Required. # Corresponds to the JSON property `carrierName` # @return [String] attr_accessor :carrier_name - # Carrier service, such as "ground" or "2 days". The list of supported services - # for a carrier can be retrieved via the getSupportedCarriers method. Required. + # Carrier service, such as `"ground"` or `"2 days"`. The list of supported + # services for a carrier can be retrieved via the `getSupportedCarriers` method. + # Required. # Corresponds to the JSON property `carrierService` # @return [String] attr_accessor :carrier_service - # Additive shipping rate modifier. Can be negative. For example ` "value": "1", " - # currency" : "USD" ` adds $1 to the rate, ` "value": "-3", "currency" : "USD" ` - # removes $3 from the rate. Optional. + # Additive shipping rate modifier. Can be negative. For example `` "value": "1", + # "currency" : "USD" `` adds $1 to the rate, `` "value": "-3", "currency" : "USD" + # `` removes $3 from the rate. Optional. # Corresponds to the JSON property `flatAdjustment` # @return [Google::Apis::ContentV2_1::Price] attr_accessor :flat_adjustment @@ -1502,7 +1510,7 @@ module Google attr_accessor :origin_postal_code # Multiplicative shipping rate modifier as a number in decimal notation. Can be - # negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the + # negative. For example `"5.4"` increases the rate by 5.4%, `"-3"` decreases the # rate by 3%. Optional. # Corresponds to the JSON property `percentageAdjustment` # @return [String] @@ -1532,12 +1540,12 @@ module Google # @return [String] attr_accessor :country - # The name of the carrier (e.g., "UPS"). Always present. + # The name of the carrier (e.g., `"UPS"`). Always present. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # A list of supported services (e.g., "ground") for that carrier. Contains at + # A list of supported services (e.g., `"ground"`) for that carrier. Contains at # least one service. # Corresponds to the JSON property `services` # @return [Array] @@ -1599,20 +1607,20 @@ module Google # Code of the return reason. # Acceptable values are: - # - "betterPriceFound" - # - "changedMind" - # - "damagedOrDefectiveItem" - # - "didNotMatchDescription" - # - "doesNotFit" - # - "expiredItem" - # - "incorrectItemReceived" - # - "noLongerNeeded" - # - "notSpecified" - # - "orderedWrongItem" - # - "other" - # - "qualityNotExpected" - # - "receivedTooLate" - # - "undeliverable" + # - "`betterPriceFound`" + # - "`changedMind`" + # - "`damagedOrDefectiveItem`" + # - "`didNotMatchDescription`" + # - "`doesNotFit`" + # - "`expiredItem`" + # - "`incorrectItemReceived`" + # - "`noLongerNeeded`" + # - "`notSpecified`" + # - "`orderedWrongItem`" + # - "`other`" + # - "`qualityNotExpected`" + # - "`receivedTooLate`" + # - "`undeliverable`" # Corresponds to the JSON property `reasonCode` # @return [String] attr_accessor :reason_code @@ -1675,9 +1683,9 @@ module Google # Required. The type of data feed. For product inventory feeds, only feeds for # local stores, not online stores, are supported. # Acceptable values are: - # - "local products" - # - "product inventory" - # - "products" + # - "`local products`" + # - "`product inventory`" + # - "`products`" # Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type @@ -1705,8 +1713,8 @@ module Google # @return [Fixnum] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string "content# - # datafeed". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # datafeed`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1792,13 +1800,13 @@ module Google # The day of the week the feed file should be fetched. # Acceptable values are: - # - "monday" - # - "tuesday" - # - "wednesday" - # - "thursday" - # - "friday" - # - "saturday" - # - "sunday" + # - "`monday`" + # - "`tuesday`" + # - "`wednesday`" + # - "`thursday`" + # - "`friday`" + # - "`saturday`" + # - "`sunday`" # Corresponds to the JSON property `weekday` # @return [String] attr_accessor :weekday @@ -1829,9 +1837,9 @@ module Google # If not specified, the delimiter will be auto-detected. Ignored for non-DSV # data feeds. # Acceptable values are: - # - "pipe" - # - "tab" - # - "tilde" + # - "`pipe`" + # - "`tab`" + # - "`tilde`" # Corresponds to the JSON property `columnDelimiter` # @return [String] attr_accessor :column_delimiter @@ -1839,11 +1847,11 @@ module Google # Character encoding scheme of the data feed. If not specified, the encoding # will be auto-detected. # Acceptable values are: - # - "latin-1" - # - "utf-16be" - # - "utf-16le" - # - "utf-8" - # - "windows-1252" + # - "`latin-1`" + # - "`utf-16be`" + # - "`utf-16le`" + # - "`utf-8`" + # - "`windows-1252`" # Corresponds to the JSON property `fileEncoding` # @return [String] attr_accessor :file_encoding @@ -1851,8 +1859,8 @@ module Google # Specifies how double quotes are interpreted. If not specified, the mode will # be auto-detected. Ignored for non-DSV data feeds. # Acceptable values are: - # - "normal character" - # - "value quoting" + # - "`normal character`" + # - "`value quoting`" # Corresponds to the JSON property `quotingMode` # @return [String] attr_accessor :quoting_mode @@ -1900,8 +1908,8 @@ module Google # @return [Fixnum] attr_accessor :items_valid - # Identifies what kind of resource this is. Value: the fixed string "content# - # datafeedStatus". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # datafeedStatus`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1918,12 +1926,12 @@ module Google # The processing status of the feed. # Acceptable values are: - # - ""failure": The feed could not be processed or all items had errors." - # - "in progress": The feed is being processed. - # - "none": The feed has not yet been processed. For example, a feed that has + # - "`"`failure`": The feed could not be processed or all items had errors.`" + # - "`in progress`": The feed is being processed. + # - "`none`": The feed has not yet been processed. For example, a feed that has # never been uploaded will have this processing status. - # - "success": The feed was processed successfully, though some items might have - # had errors. + # - "`success`": The feed was processed successfully, though some items might + # have had errors. # Corresponds to the JSON property `processingStatus` # @return [String] attr_accessor :processing_status @@ -2038,7 +2046,7 @@ module Google # The list of destinations to include for this target (corresponds to checked # check boxes in Merchant Center). Default destinations are always included - # unless provided in excludedDestinations. + # unless provided in `excludedDestinations`. # List of supported destinations (if available to the account): # - DisplayAds # - Shopping @@ -2049,7 +2057,7 @@ module Google attr_accessor :included_destinations # The two-letter ISO 639-1 language of the items in the feed. Must be a valid - # language for targets[].country. + # language for `targets[].country`. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language @@ -2112,11 +2120,11 @@ module Google # The method of the batch entry. # Acceptable values are: - # - "delete" - # - "fetchNow" - # - "get" - # - "insert" - # - "update" + # - "`delete`" + # - "`fetchNow`" + # - "`get`" + # - "`insert`" + # - "`update`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -2298,7 +2306,7 @@ module Google # The method of the batch entry. # Acceptable values are: - # - "get" + # - "`get`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -2431,15 +2439,15 @@ module Google attr_accessor :holiday_cutoffs # Maximum number of business days spent before an order is shipped. 0 means same - # day shipped, 1 means next day shipped. Must be greater than or equal to - # minHandlingTimeInDays. + # day shipped, 1 means next day shipped. Must be greater than or equal to ` + # minHandlingTimeInDays`. # Corresponds to the JSON property `maxHandlingTimeInDays` # @return [Fixnum] attr_accessor :max_handling_time_in_days # Maximum number of business days that is spent in transit. 0 means same day - # delivery, 1 means next day delivery. Must be greater than or equal to - # minTransitTimeInDays. + # delivery, 1 means next day delivery. Must be greater than or equal to ` + # minTransitTimeInDays`. # Corresponds to the JSON property `maxTransitTimeInDays` # @return [Fixnum] attr_accessor :max_transit_time_in_days @@ -2451,8 +2459,8 @@ module Google attr_accessor :min_handling_time_in_days # Minimum number of business days that is spent in transit. 0 means same day - # delivery, 1 means next day delivery. Either `min,max`TransitTimeInDays or - # transitTimeTable must be set, but not both. + # delivery, 1 means next day delivery. Either ``min,max`TransitTimeInDays` or ` + # transitTimeTable` must be set, but not both. # Corresponds to the JSON property `minTransitTimeInDays` # @return [Fixnum] attr_accessor :min_transit_time_in_days @@ -2464,8 +2472,8 @@ module Google attr_accessor :transit_business_day_config # Transit time table, number of business days spent in transit based on row and - # column dimensions. Either `min,max`TransitTimeInDays or transitTimeTable can - # be set, but not both. + # column dimensions. Either ``min,max`TransitTimeInDays` or `transitTimeTable` + # can be set, but not both. # Corresponds to the JSON property `transitTimeTable` # @return [Google::Apis::ContentV2_1::TransitTable] attr_accessor :transit_time_table @@ -2523,7 +2531,7 @@ module Google class Errors include Google::Apis::Core::Hashable - # The HTTP status of the first error in errors. + # The HTTP status of the first error in `errors`. # Corresponds to the JSON property `code` # @return [Fixnum] attr_accessor :code @@ -2533,7 +2541,7 @@ module Google # @return [Array] attr_accessor :errors - # The message of the first error in errors. + # The message of the first error in `errors`. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -2554,7 +2562,7 @@ module Google class GmbAccounts include Google::Apis::Core::Hashable - # The ID of the account. + # The ID of the Merchant Center account. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id @@ -2612,8 +2620,8 @@ module Google end end - # A non-empty list of row or column headers for a table. Exactly one of prices, - # weights, numItems, postalCodeGroupNames, or location must be set. + # A non-empty list of row or column headers for a table. Exactly one of `prices`, + # `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set. class Headers include Google::Apis::Core::Hashable @@ -2623,36 +2631,36 @@ module Google # @return [Array] attr_accessor :locations - # A list of inclusive number of items upper bounds. The last value can be " - # infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 - # items", " 50 items". Must be non-empty. Can only be set if all other fields + # A list of inclusive number of items upper bounds. The last value can be `" + # infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= + # 10 items", " 50 items". Must be non-empty. Can only be set if all other fields # are not set. # Corresponds to the JSON property `numberOfItems` # @return [Array] attr_accessor :number_of_items - # A list of postal group names. The last value can be "all other locations". - # Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code - # groups must match the delivery country of the service. Must be non-empty. Can - # only be set if all other fields are not set. + # A list of postal group names. The last value can be `"all other locations"`. + # Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal + # code groups must match the delivery country of the service. Must be non-empty. + # Can only be set if all other fields are not set. # Corresponds to the JSON property `postalCodeGroupNames` # @return [Array] attr_accessor :postal_code_group_names - # A list of inclusive order price upper bounds. The last price's value can be " - # infinity". For example [`"value": "10", "currency": "USD"`, `"value": "500", " - # currency": "USD"`, `"value": "infinity", "currency": "USD"`] represents the + # A list of inclusive order price upper bounds. The last price's value can be `" + # infinity"`. For example `[`"value": "10", "currency": "USD"`, `"value": "500", + # "currency": "USD"`, `"value": "infinity", "currency": "USD"`]` represents the # headers "<= $10", " $500". All prices within a service must have the same # currency. Must be non-empty. Can only be set if all other fields are not set. # Corresponds to the JSON property `prices` # @return [Array] attr_accessor :prices - # A list of inclusive order weight upper bounds. The last weight's value can be " - # infinity". For example [`"value": "10", "unit": "kg"`, `"value": "50", "unit": - # "kg"`, `"value": "infinity", "unit": "kg"`] represents the headers "<= 10kg", " - # 50kg". All weights within a service must have the same unit. Must be non- - # empty. Can only be set if all other fields are not set. + # A list of inclusive order weight upper bounds. The last weight's value can be ` + # "infinity"`. For example `[`"value": "10", "unit": "kg"`, `"value": "50", " + # unit": "kg"`, `"value": "infinity", "unit": "kg"`]` represents the headers "<= + # 10kg", " 50kg". All weights within a service must have the same unit. Must be + # non-empty. Can only be set if all other fields are not set. # Corresponds to the JSON property `weights` # @return [Array] attr_accessor :weights @@ -2757,14 +2765,14 @@ module Google # The holiday type. Always present. # Acceptable values are: - # - "Christmas" - # - "Easter" - # - "Father's Day" - # - "Halloween" - # - "Independence Day (USA)" - # - "Mother's Day" - # - "Thanksgiving" - # - "Valentine's Day" + # - "`Christmas`" + # - "`Easter`" + # - "`Father's Day`" + # - "`Halloween`" + # - "`Independence Day (USA)`" + # - "`Mother's Day`" + # - "`Thanksgiving`" + # - "`Valentine's Day`" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -2845,7 +2853,7 @@ module Google # [required] Type of the additional charge. # Acceptable values are: - # - "shipping" + # - "`shipping`" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -2867,9 +2875,9 @@ module Google # The status of the verification process for the About page. # Acceptable values are: - # - "active" - # - "inactive" - # - "pending" + # - "`active`" + # - "`inactive`" + # - "`pending`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -2963,18 +2971,18 @@ module Google # The status of the verification contact. # Acceptable values are: - # - "active" - # - "inactive" - # - "pending" + # - "`active`" + # - "`inactive`" + # - "`pending`" # Corresponds to the JSON property `inventoryVerificationContactStatus` # @return [String] attr_accessor :inventory_verification_contact_status # The status of the inventory verification process. # Acceptable values are: - # - "active" - # - "inactive" - # - "pending" + # - "`active`" + # - "`inactive`" + # - "`pending`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -3003,9 +3011,9 @@ module Google # The status of the ?On display to order? feature. # Acceptable values are: - # - "active" - # - "inactive" - # - "pending" + # - "`active`" + # - "`inactive`" + # - "`pending`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -3062,8 +3070,8 @@ module Google # @return [Array] attr_accessor :country_settings - # Identifies what kind of resource this is. Value: the fixed string "content# - # liaSettings". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # liaSettings`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3103,7 +3111,7 @@ module Google class LiasettingsCustomBatchRequestEntry include Google::Apis::Core::Hashable - # The ID of the account for which to get/update account shipping settings. + # The ID of the account for which to get/update account LIA settings. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id @@ -3148,12 +3156,12 @@ module Google # The method of the batch entry. # Acceptable values are: - # - "get" - # - "getAccessibleGmbAccounts" - # - "requestGmbAccess" - # - "requestInventoryVerification" - # - "setInventoryVerificationContact" - # - "update" + # - "`get`" + # - "`getAccessibleGmbAccounts`" + # - "`requestGmbAccess`" + # - "`requestInventoryVerification`" + # - "`setInventoryVerificationContact`" + # - "`update`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -3233,8 +3241,8 @@ module Google # @return [Google::Apis::ContentV2_1::GmbAccounts] attr_accessor :gmb_accounts - # Identifies what kind of resource this is. Value: the fixed string "content# - # liasettingsCustomBatchResponseEntry". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # liasettingsCustomBatchResponseEntry`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3269,7 +3277,7 @@ module Google class LiasettingsGetAccessibleGmbAccountsResponse include Google::Apis::Core::Hashable - # The ID of the account. + # The ID of the Merchant Center account. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id @@ -3441,18 +3449,18 @@ module Google # Service provided to or by the linked account. # Acceptable values are: - # - "shoppingActionsOrderManagement" - # - "shoppingActionsProductManagement" - # - "shoppingAdsProductManagement" + # - "`shoppingActionsOrderManagement`" + # - "`shoppingActionsProductManagement`" + # - "`shoppingAdsProductManagement`" # Corresponds to the JSON property `service` # @return [String] attr_accessor :service # Status of the link # Acceptable values are: - # - "active" - # - "inactive" - # - "pending" + # - "`active`" + # - "`inactive`" + # - "`pending`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -3508,20 +3516,20 @@ module Google # @return [String] attr_accessor :instore_product_location - # Identifies what kind of resource this is. Value: the fixed string "content# - # localInventory". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # localInventory`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Supported pickup method for this offer. Unless the value is "not supported", - # this field must be submitted together with pickupSla. + # this field must be submitted together with `pickupSla`. # Corresponds to the JSON property `pickupMethod` # @return [String] attr_accessor :pickup_method # Expected date that an order will be ready for pickup relative to the order - # date. Must be submitted together with pickupMethod. + # date. Must be submitted together with `pickupMethod`. # Corresponds to the JSON property `pickupSla` # @return [String] attr_accessor :pickup_sla @@ -3536,7 +3544,7 @@ module Google # @return [Fixnum] attr_accessor :quantity - # Sale price of the product. Mandatory if sale_price_effective_date is defined. + # Sale price of the product. Mandatory if `sale_price_effective_date` is defined. # Corresponds to the JSON property `salePrice` # @return [Google::Apis::ContentV2_1::Price] attr_accessor :sale_price @@ -3612,7 +3620,7 @@ module Google # Method of the batch request entry. # Acceptable values are: - # - "insert" + # - "`insert`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -3676,8 +3684,8 @@ module Google # @return [Google::Apis::ContentV2_1::Errors] attr_accessor :errors - # Identifies what kind of resource this is. Value: the fixed string "content# - # localinventoryCustomBatchResponseEntry". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # localinventoryCustomBatchResponseEntry`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3777,6 +3785,11 @@ module Google # @return [Array] attr_accessor :return_items + # Information about shipping costs. + # Corresponds to the JSON property `returnPricingInfo` + # @return [Google::Apis::ContentV2_1::ReturnPricingInfo] + attr_accessor :return_pricing_info + # Shipments of the return. # Corresponds to the JSON property `returnShipments` # @return [Array] @@ -3793,6 +3806,7 @@ module Google @order_id = args[:order_id] if args.key?(:order_id) @order_return_id = args[:order_return_id] if args.key?(:order_return_id) @return_items = args[:return_items] if args.key?(:return_items) + @return_pricing_info = args[:return_pricing_info] if args.key?(:return_pricing_info) @return_shipments = args[:return_shipments] if args.key?(:return_shipments) end end @@ -3812,6 +3826,11 @@ module Google # @return [String] attr_accessor :item_id + # The reason that the merchant chose to reject an item return. + # Corresponds to the JSON property `merchantRejectionReason` + # @return [Google::Apis::ContentV2_1::MerchantRejectionReason] + attr_accessor :merchant_rejection_reason + # The reason that merchant chooses to accept a return item. # Corresponds to the JSON property `merchantReturnReason` # @return [Google::Apis::ContentV2_1::RefundReason] @@ -3822,18 +3841,40 @@ module Google # @return [Google::Apis::ContentV2_1::OrderLineItemProduct] attr_accessor :product + # Maximum amount that can be refunded for this return item. + # Corresponds to the JSON property `refundableAmount` + # @return [Google::Apis::ContentV2_1::MonetaryAmount] + attr_accessor :refundable_amount + + # Unit level ID for the return item. Different units of the same product will + # have different IDs. + # Corresponds to the JSON property `returnItemId` + # @return [String] + attr_accessor :return_item_id + # IDs of the return shipments that this return item belongs to. # Corresponds to the JSON property `returnShipmentIds` # @return [Array] attr_accessor :return_shipment_ids + # ID of the original shipment group. Provided for shipments with invoice support. + # Corresponds to the JSON property `shipmentGroupId` + # @return [String] + attr_accessor :shipment_group_id + + # ID of the shipment unit assigned by the merchant. Provided for shipments with + # invoice support. + # Corresponds to the JSON property `shipmentUnitId` + # @return [String] + attr_accessor :shipment_unit_id + # State of the item. # Acceptable values are: - # - "canceled" - # - "new" - # - "received" - # - "refunded" - # - "rejected" + # - "`canceled`" + # - "`new`" + # - "`received`" + # - "`refunded`" + # - "`rejected`" # Corresponds to the JSON property `state` # @return [String] attr_accessor :state @@ -3846,15 +3887,122 @@ module Google def update!(**args) @customer_return_reason = args[:customer_return_reason] if args.key?(:customer_return_reason) @item_id = args[:item_id] if args.key?(:item_id) + @merchant_rejection_reason = args[:merchant_rejection_reason] if args.key?(:merchant_rejection_reason) @merchant_return_reason = args[:merchant_return_reason] if args.key?(:merchant_return_reason) @product = args[:product] if args.key?(:product) + @refundable_amount = args[:refundable_amount] if args.key?(:refundable_amount) + @return_item_id = args[:return_item_id] if args.key?(:return_item_id) @return_shipment_ids = args[:return_shipment_ids] if args.key?(:return_shipment_ids) + @shipment_group_id = args[:shipment_group_id] if args.key?(:shipment_group_id) + @shipment_unit_id = args[:shipment_unit_id] if args.key?(:shipment_unit_id) @state = args[:state] if args.key?(:state) end end + # + class MerchantRejectionReason + include Google::Apis::Core::Hashable + + # Description of the reason. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Code of the rejection reason. + # Corresponds to the JSON property `reasonCode` + # @return [String] + attr_accessor :reason_code + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @reason_code = args[:reason_code] if args.key?(:reason_code) + end + end + + # + class MinimumOrderValueTable + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `storeCodeSetWithMovs` + # @return [Array] + attr_accessor :store_code_set_with_movs + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @store_code_set_with_movs = args[:store_code_set_with_movs] if args.key?(:store_code_set_with_movs) + end + end + + # A list of store code sets sharing the same minimum order value. At least two + # sets are required and the last one must be empty, which signifies 'MOV for all + # other stores'. Each store code can only appear once across all the sets. All + # prices within a service must have the same currency. + class MinimumOrderValueTableStoreCodeSetWithMov + include Google::Apis::Core::Hashable + + # A list of unique store codes or empty for the catch all. + # Corresponds to the JSON property `storeCodes` + # @return [Array] + attr_accessor :store_codes + + # The minimum order value for the given stores. + # Corresponds to the JSON property `value` + # @return [Google::Apis::ContentV2_1::Price] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @store_codes = args[:store_codes] if args.key?(:store_codes) + @value = args[:value] if args.key?(:value) + end + end + + # + class MonetaryAmount + include Google::Apis::Core::Hashable + + # The pre-tax or post-tax price depends on the location of the order. - For + # countries (e.g. US) where price attribute excludes tax, this field corresponds + # to the pre-tax value. - For coutries (e.g. France) where price attribute + # includes tax, this field corresponds to the post-tax value . + # Corresponds to the JSON property `priceAmount` + # @return [Google::Apis::ContentV2_1::Price] + attr_accessor :price_amount + + # Tax value, present only for countries where price attribute excludes tax (e.g. + # US). No tax is referenced as 0 value with the corresponding `currency`. + # Corresponds to the JSON property `taxAmount` + # @return [Google::Apis::ContentV2_1::Price] + attr_accessor :tax_amount + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @price_amount = args[:price_amount] if args.key?(:price_amount) + @tax_amount = args[:tax_amount] if args.key?(:tax_amount) + end + end + # Order. Production access (all methods) requires the order manager role. - # Sandbox access does not. + # Sandbox access does not. (== resource_for v2.orders ==) (== resource_for v2.1. + # orders ==) class Order include Google::Apis::Core::Hashable @@ -3874,7 +4022,7 @@ module Google # @return [Google::Apis::ContentV2_1::OrderCustomer] attr_accessor :customer - # Delivery details for shipments of type delivery. + # Delivery details for shipments of type `delivery`. # Corresponds to the JSON property `deliveryDetails` # @return [Google::Apis::ContentV2_1::OrderDeliveryDetails] attr_accessor :delivery_details @@ -3884,8 +4032,8 @@ module Google # @return [String] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string "content# - # order". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # order`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3913,7 +4061,7 @@ module Google attr_accessor :net_price_amount # The net amount for the order (tax part). Note that in certain cases due to - # taxable base adjustment netTaxAmount might not match to a sum of tax field + # taxable base adjustment `netTaxAmount` might not match to a sum of tax field # across all lineItems and refunds. # Corresponds to the JSON property `netTaxAmount` # @return [Google::Apis::ContentV2_1::Price] @@ -3921,15 +4069,15 @@ module Google # The status of the payment. # Acceptable values are: - # - "paymentCaptured" - # - "paymentRejected" - # - "paymentSecured" - # - "pendingAuthorization" + # - "`paymentCaptured`" + # - "`paymentRejected`" + # - "`paymentSecured`" + # - "`pendingAuthorization`" # Corresponds to the JSON property `paymentStatus` # @return [String] attr_accessor :payment_status - # Pickup details for shipments of type pickup. + # Pickup details for shipments of type `pickup`. # Corresponds to the JSON property `pickupDetails` # @return [Google::Apis::ContentV2_1::OrderPickupDetails] attr_accessor :pickup_details @@ -3940,20 +4088,20 @@ module Google attr_accessor :placed_date # Promotions associated with the order. - # To determine which promotions apply to which products, check the Promotions[]. - # appliedItems[].lineItemId field against the LineItems[].id field for each + # To determine which promotions apply to which products, check the `Promotions[]. + # appliedItems[].lineItemId` field against the `LineItems[].id` field for each # promotion. If a promotion is applied to more than 1 offerId, divide the # discount value by the number of affected offers to determine how much discount # to apply to each offerId. # Examples: # - To calculate price paid by the customer for a single line item including the - # discount: For each promotion, subtract the LineItems[].adjustments[]. - # priceAdjustment.value amount from the LineItems[].Price.value. + # discount: For each promotion, subtract the `LineItems[].adjustments[]. + # priceAdjustment.value` amount from the `LineItems[].Price.value`. # - To calculate price paid by the customer for a single line item including the - # discount in case of multiple quantity: For each promotion, divide the - # LineItems[].adjustments[].priceAdjustment.value by the quantity of products - # then subtract the resulting value from the LineItems[].Product.Price.value for - # each quantity item. + # discount in case of multiple quantity: For each promotion, divide the ` + # LineItems[].adjustments[].priceAdjustment.value` by the quantity of products + # then subtract the resulting value from the `LineItems[].Product.Price.value` + # for each quantity item. # Only 1 promotion can be applied to an offerId in a given order. To refund an # item which had a promotion applied to it, make sure to refund the amount after # first subtracting the promotion discount from the item price. @@ -3984,23 +4132,23 @@ module Google # The status of the order. # Acceptable values are: - # - "canceled" - # - "delivered" - # - "inProgress" - # - "partiallyDelivered" - # - "partiallyReturned" - # - "partiallyShipped" - # - "pendingShipment" - # - "returned" - # - "shipped" + # - "`canceled`" + # - "`delivered`" + # - "`inProgress`" + # - "`partiallyDelivered`" + # - "`partiallyReturned`" + # - "`partiallyShipped`" + # - "`pendingShipment`" + # - "`returned`" + # - "`shipped`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The party responsible for collecting and remitting taxes. # Acceptable values are: - # - "marketplaceFacilitator" - # - "merchant" + # - "`marketplaceFacilitator`" + # - "`merchant`" # Corresponds to the JSON property `taxCollector` # @return [String] attr_accessor :tax_collector @@ -4110,12 +4258,12 @@ module Google # The actor that created the cancellation. # Acceptable values are: - # - "customer" - # - "googleBot" - # - "googleCustomerService" - # - "googlePayments" - # - "googleSabre" - # - "merchant" + # - "`customer`" + # - "`googleBot`" + # - "`googleCustomerService`" + # - "`googlePayments`" + # - "`googleSabre`" + # - "`merchant`" # Corresponds to the JSON property `actor` # @return [String] attr_accessor :actor @@ -4134,34 +4282,34 @@ module Google # reason will lead to the removal of the product from Shopping Actions until you # make an update to that product. This will not affect your Shopping ads. # Acceptable values are: - # - "autoPostInternal" - # - "autoPostInvalidBillingAddress" - # - "autoPostNoInventory" - # - "autoPostPriceError" - # - "autoPostUndeliverableShippingAddress" - # - "couponAbuse" - # - "customerCanceled" - # - "customerInitiatedCancel" - # - "customerSupportRequested" - # - "failToPushOrderGoogleError" - # - "failToPushOrderMerchantError" - # - "failToPushOrderMerchantFulfillmentError" - # - "failToPushOrderToMerchant" - # - "failToPushOrderToMerchantOutOfStock" - # - "invalidCoupon" - # - "malformedShippingAddress" - # - "merchantDidNotShipOnTime" - # - "noInventory" - # - "orderTimeout" - # - "other" - # - "paymentAbuse" - # - "paymentDeclined" - # - "priceError" - # - "returnRefundAbuse" - # - "shippingPriceError" - # - "taxError" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" + # - "`autoPostInternal`" + # - "`autoPostInvalidBillingAddress`" + # - "`autoPostNoInventory`" + # - "`autoPostPriceError`" + # - "`autoPostUndeliverableShippingAddress`" + # - "`couponAbuse`" + # - "`customerCanceled`" + # - "`customerInitiatedCancel`" + # - "`customerSupportRequested`" + # - "`failToPushOrderGoogleError`" + # - "`failToPushOrderMerchantError`" + # - "`failToPushOrderMerchantFulfillmentError`" + # - "`failToPushOrderToMerchant`" + # - "`failToPushOrderToMerchantOutOfStock`" + # - "`invalidCoupon`" + # - "`malformedShippingAddress`" + # - "`merchantDidNotShipOnTime`" + # - "`noInventory`" + # - "`orderTimeout`" + # - "`other`" + # - "`paymentAbuse`" + # - "`paymentDeclined`" + # - "`priceError`" + # - "`returnRefundAbuse`" + # - "`shippingPriceError`" + # - "`taxError`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -4195,8 +4343,9 @@ module Google attr_accessor :full_name # Email address for the merchant to send value-added tax or invoice - # documentation of the order. This documentation is made available to the - # customer. + # documentation of the order. Only the last document sent is made available to + # the customer. For more information, see About automated VAT invoicing for + # Shopping Actions. # Corresponds to the JSON property `invoiceReceivingEmail` # @return [String] attr_accessor :invoice_receiving_email @@ -4258,12 +4407,12 @@ module Google # Last known customer selection regarding marketing preferences. In certain # cases this selection might not be known, so this field would be empty. If a - # customer selected granted in their most recent order, they can be subscribed - # to marketing emails. Customers who have chosen denied must not be subscribed, + # customer selected `granted` in their most recent order, they can be subscribed + # to marketing emails. Customers who have chosen `denied` must not be subscribed, # or must be unsubscribed if already opted-in. # Acceptable values are: - # - "denied" - # - "granted" + # - "`denied`" + # - "`granted`" # Corresponds to the JSON property `explicitMarketingPreference` # @return [String] attr_accessor :explicit_marketing_preference @@ -4275,8 +4424,8 @@ module Google attr_accessor :last_updated_timestamp # Email address that can be used for marketing purposes. The field may be empty - # even if explicitMarketingPreference is 'granted'. This happens when retrieving - # an old order from the customer who deleted their account. + # even if `explicitMarketingPreference` is 'granted'. This happens when + # retrieving an old order from the customer who deleted their account. # Corresponds to the JSON property `marketingEmailAddress` # @return [String] attr_accessor :marketing_email_address @@ -4459,7 +4608,7 @@ module Google # Type of this adjustment. # Acceptable values are: - # - "promotion" + # - "`promotion`" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -4487,9 +4636,9 @@ module Google # Condition or state of the item. # Acceptable values are: - # - "new" - # - "refurbished" - # - "used" + # - "`new`" + # - "`refurbished`" + # - "`used`" # Corresponds to the JSON property `condition` # @return [String] attr_accessor :condition @@ -4686,11 +4835,11 @@ module Google # @return [String] attr_accessor :ship_by_date - # Type of shipment. Indicates whether deliveryDetails or pickupDetails is + # Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is # applicable for this shipment. # Acceptable values are: - # - "delivery" - # - "pickup" + # - "`delivery`" + # - "`pickup`" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -4712,8 +4861,8 @@ module Google class OrderLineItemShippingDetailsMethod include Google::Apis::Core::Hashable - # The carrier for the shipping. Optional. See shipments[].carrier for a list of - # acceptable values. + # The carrier for the shipping. Optional. See `shipments[].carrier` for a list + # of acceptable values. # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier @@ -4777,8 +4926,8 @@ module Google class OrderPickupDetails include Google::Apis::Core::Hashable - # Address of the pickup location where the shipment should be sent. Note that - # recipientName in the address is the name of the business at the pickup + # Address of the pickup location where the shipment should be sent. Note that ` + # recipientName` in the address is the name of the business at the pickup # location. # Corresponds to the JSON property `address` # @return [Google::Apis::ContentV2_1::OrderAddress] @@ -4841,8 +4990,8 @@ module Google # @return [Array] attr_accessor :applicable_items - # Items which this promotion have been applied to. Do not provide for orders. - # createtestorder. + # Items which this promotion have been applied to. Do not provide for `orders. + # createtestorder`. # Corresponds to the JSON property `appliedItems` # @return [Array] attr_accessor :applied_items @@ -4853,11 +5002,11 @@ module Google # @return [String] attr_accessor :end_time - # Required. The party funding the promotion. Only merchant is supported for - # orders.createtestorder. + # Required. The party funding the promotion. Only `merchant` is supported for ` + # orders.createtestorder`. # Acceptable values are: - # - "google" - # - "merchant" + # - "`google`" + # - "`merchant`" # Corresponds to the JSON property `funder` # @return [String] attr_accessor :funder @@ -4875,7 +5024,7 @@ module Google attr_accessor :price_value # A short title of the promotion to be shown on the checkout page. Do not - # provide for orders.createtestorder. + # provide for `orders.createtestorder`. # Corresponds to the JSON property `shortTitle` # @return [String] attr_accessor :short_title @@ -4886,29 +5035,29 @@ module Google # @return [String] attr_accessor :start_time - # Required. The category of the promotion. Only moneyOff is supported for orders. - # createtestorder. + # Required. The category of the promotion. Only `moneyOff` is supported for ` + # orders.createtestorder`. # Acceptable values are: - # - "buyMGetMoneyOff" - # - "buyMGetNMoneyOff" - # - "buyMGetNPercentOff" - # - "buyMGetPercentOff" - # - "freeGift" - # - "freeGiftWithItemId" - # - "freeGiftWithValue" - # - "freeShippingOvernight" - # - "freeShippingStandard" - # - "freeShippingTwoDay" - # - "moneyOff" - # - "percentOff" - # - "rewardPoints" - # - "salePrice" + # - "`buyMGetMoneyOff`" + # - "`buyMGetNMoneyOff`" + # - "`buyMGetNPercentOff`" + # - "`buyMGetPercentOff`" + # - "`freeGift`" + # - "`freeGiftWithItemId`" + # - "`freeGiftWithValue`" + # - "`freeShippingOvernight`" + # - "`freeShippingStandard`" + # - "`freeShippingTwoDay`" + # - "`moneyOff`" + # - "`percentOff`" + # - "`rewardPoints`" + # - "`salePrice`" # Corresponds to the JSON property `subtype` # @return [String] attr_accessor :subtype - # Estimated discount applied to tax (if allowed by law). Do not provide for - # orders.createtestorder. + # Estimated discount applied to tax (if allowed by law). Do not provide for ` + # orders.createtestorder`. # Corresponds to the JSON property `taxValue` # @return [Google::Apis::ContentV2_1::Price] attr_accessor :tax_value @@ -4918,11 +5067,11 @@ module Google # @return [String] attr_accessor :title - # Required. The scope of the promotion. Only product is supported for orders. - # createtestorder. + # Required. The scope of the promotion. Only `product` is supported for `orders. + # createtestorder`. # Acceptable values are: - # - "product" - # - "shipping" + # - "`product`" + # - "`shipping`" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -4952,23 +5101,23 @@ module Google class OrderPromotionItem include Google::Apis::Core::Hashable - # The line item ID of a product. Do not provide for orders.createtestorder. + # The line item ID of a product. Do not provide for `orders.createtestorder`. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id - # Required. Offer ID of a product. Only for orders.createtestorder. + # Required. Offer ID of a product. Only for `orders.createtestorder`. # Corresponds to the JSON property `offerId` # @return [String] attr_accessor :offer_id - # orders.createtestorder. + # `orders.createtestorder`. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id - # The quantity of the associated product. Do not provide for orders. - # createtestorder. + # The quantity of the associated product. Do not provide for `orders. + # createtestorder`. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity @@ -4992,12 +5141,12 @@ module Google # The actor that created the refund. # Acceptable values are: - # - "customer" - # - "googleBot" - # - "googleCustomerService" - # - "googlePayments" - # - "googleSabre" - # - "merchant" + # - "`customer`" + # - "`googleBot`" + # - "`googleCustomerService`" + # - "`googlePayments`" + # - "`googleSabre`" + # - "`merchant`" # Corresponds to the JSON property `actor` # @return [String] attr_accessor :actor @@ -5014,50 +5163,50 @@ module Google # The reason for the refund. # Acceptable values are: - # - "adjustment" - # - "autoPostInternal" - # - "autoPostInvalidBillingAddress" - # - "autoPostNoInventory" - # - "autoPostPriceError" - # - "autoPostUndeliverableShippingAddress" - # - "couponAbuse" - # - "courtesyAdjustment" - # - "customerCanceled" - # - "customerDiscretionaryReturn" - # - "customerInitiatedMerchantCancel" - # - "customerSupportRequested" - # - "deliveredLateByCarrier" - # - "deliveredTooLate" - # - "expiredItem" - # - "failToPushOrderGoogleError" - # - "failToPushOrderMerchantError" - # - "failToPushOrderMerchantFulfillmentError" - # - "failToPushOrderToMerchant" - # - "failToPushOrderToMerchantOutOfStock" - # - "feeAdjustment" - # - "invalidCoupon" - # - "lateShipmentCredit" - # - "malformedShippingAddress" - # - "merchantDidNotShipOnTime" - # - "noInventory" - # - "orderTimeout" - # - "other" - # - "paymentAbuse" - # - "paymentDeclined" - # - "priceAdjustment" - # - "priceError" - # - "productArrivedDamaged" - # - "productNotAsDescribed" - # - "promoReallocation" - # - "qualityNotAsExpected" - # - "returnRefundAbuse" - # - "shippingCostAdjustment" - # - "shippingPriceError" - # - "taxAdjustment" - # - "taxError" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" - # - "wrongProductShipped" + # - "`adjustment`" + # - "`autoPostInternal`" + # - "`autoPostInvalidBillingAddress`" + # - "`autoPostNoInventory`" + # - "`autoPostPriceError`" + # - "`autoPostUndeliverableShippingAddress`" + # - "`couponAbuse`" + # - "`courtesyAdjustment`" + # - "`customerCanceled`" + # - "`customerDiscretionaryReturn`" + # - "`customerInitiatedMerchantCancel`" + # - "`customerSupportRequested`" + # - "`deliveredLateByCarrier`" + # - "`deliveredTooLate`" + # - "`expiredItem`" + # - "`failToPushOrderGoogleError`" + # - "`failToPushOrderMerchantError`" + # - "`failToPushOrderMerchantFulfillmentError`" + # - "`failToPushOrderToMerchant`" + # - "`failToPushOrderToMerchantOutOfStock`" + # - "`feeAdjustment`" + # - "`invalidCoupon`" + # - "`lateShipmentCredit`" + # - "`malformedShippingAddress`" + # - "`merchantDidNotShipOnTime`" + # - "`noInventory`" + # - "`orderTimeout`" + # - "`other`" + # - "`paymentAbuse`" + # - "`paymentDeclined`" + # - "`priceAdjustment`" + # - "`priceError`" + # - "`productArrivedDamaged`" + # - "`productNotAsDescribed`" + # - "`promoReallocation`" + # - "`qualityNotAsExpected`" + # - "`returnRefundAbuse`" + # - "`shippingCostAdjustment`" + # - "`shippingPriceError`" + # - "`taxAdjustment`" + # - "`taxError`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" + # - "`wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -5081,7 +5230,8 @@ module Google end end - # Order disbursement. All methods require the payment analyst role. + # Order disbursement. All methods require the payment analyst role. (== + # resource_for v2.orderreports ==) (== resource_for v2.1.orderreports ==) class OrderReportDisbursement include Google::Apis::Core::Hashable @@ -5197,12 +5347,12 @@ module Google # The actor that created the refund. # Acceptable values are: - # - "customer" - # - "googleBot" - # - "googleCustomerService" - # - "googlePayments" - # - "googleSabre" - # - "merchant" + # - "`customer`" + # - "`googleBot`" + # - "`googleCustomerService`" + # - "`googlePayments`" + # - "`googleSabre`" + # - "`merchant`" # Corresponds to the JSON property `actor` # @return [String] attr_accessor :actor @@ -5219,19 +5369,19 @@ module Google # The reason for the return. # Acceptable values are: - # - "customerDiscretionaryReturn" - # - "customerInitiatedMerchantCancel" - # - "deliveredTooLate" - # - "expiredItem" - # - "invalidCoupon" - # - "malformedShippingAddress" - # - "other" - # - "productArrivedDamaged" - # - "productNotAsDescribed" - # - "qualityNotAsExpected" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" - # - "wrongProductShipped" + # - "`customerDiscretionaryReturn`" + # - "`customerInitiatedMerchantCancel`" + # - "`deliveredTooLate`" + # - "`expiredItem`" + # - "`invalidCoupon`" + # - "`malformedShippingAddress`" + # - "`other`" + # - "`productArrivedDamaged`" + # - "`productNotAsDescribed`" + # - "`qualityNotAsExpected`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" + # - "`wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -5267,42 +5417,42 @@ module Google # carrier name or tracking URL, and there will be no automatic order status # updates. # Supported carriers for US are: - # - "ups" (United Parcel Service) automatic status updates - # - "usps" (United States Postal Service) automatic status updates - # - "fedex" (FedEx) automatic status updates - # - "dhl" (DHL eCommerce) automatic status updates (US only) - # - "ontrac" (OnTrac) automatic status updates - # - "dhl express" (DHL Express) - # - "deliv" (Deliv) - # - "dynamex" (TForce) - # - "lasership" (LaserShip) - # - "mpx" (Military Parcel Xpress) - # - "uds" (United Delivery Service) - # - "efw" (Estes Forwarding Worldwide) - # - "jd logistics" (JD Logistics) - # - "yunexpress" (YunExpress) - # - "china post" (China Post) - # - "china ems" (China Post Express Mail Service) - # - "singapore post" (Singapore Post) - # - "pos malaysia" (Pos Malaysia) - # - "postnl" (PostNL) - # - "ptt" (PTT Turkish Post) - # - "eub" (ePacket) - # - "chukou1" (Chukou1 Logistics) + # - "`ups`" (United Parcel Service) automatic status updates + # - "`usps`" (United States Postal Service) automatic status updates + # - "`fedex`" (FedEx) automatic status updates + # - "`dhl`" (DHL eCommerce) automatic status updates (US only) + # - "`ontrac`" (OnTrac) automatic status updates + # - "`dhl express`" (DHL Express) + # - "`deliv`" (Deliv) + # - "`dynamex`" (TForce) + # - "`lasership`" (LaserShip) + # - "`mpx`" (Military Parcel Xpress) + # - "`uds`" (United Delivery Service) + # - "`efw`" (Estes Forwarding Worldwide) + # - "`jd logistics`" (JD Logistics) + # - "`yunexpress`" (YunExpress) + # - "`china post`" (China Post) + # - "`china ems`" (China Post Express Mail Service) + # - "`singapore post`" (Singapore Post) + # - "`pos malaysia`" (Pos Malaysia) + # - "`postnl`" (PostNL) + # - "`ptt`" (PTT Turkish Post) + # - "`eub`" (ePacket) + # - "`chukou1`" (Chukou1 Logistics) # Supported carriers for FR are: - # - "la poste" (La Poste) automatic status updates - # - "colissimo" (Colissimo by La Poste) automatic status updates - # - "ups" (United Parcel Service) automatic status updates - # - "chronopost" (Chronopost by La Poste) - # - "gls" (General Logistics Systems France) - # - "dpd" (DPD Group by GeoPost) - # - "bpost" (Belgian Post Group) - # - "colis prive" (Colis Privé) - # - "boxtal" (Boxtal) - # - "geodis" (GEODIS) - # - "tnt" (TNT) - # - "db schenker" (DB Schenker) - # - "aramex" (Aramex) + # - "`la poste`" (La Poste) automatic status updates + # - "`colissimo`" (Colissimo by La Poste) automatic status updates + # - "`ups`" (United Parcel Service) automatic status updates + # - "`chronopost`" (Chronopost by La Poste) + # - "`gls`" (General Logistics Systems France) + # - "`dpd`" (DPD Group by GeoPost) + # - "`bpost`" (Belgian Post Group) + # - "`colis prive`" (Colis Privé) + # - "`boxtal`" (Boxtal) + # - "`geodis`" (GEODIS) + # - "`tnt`" (TNT) + # - "`db schenker`" (DB Schenker) + # - "`aramex`" (Aramex) # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier @@ -5313,7 +5463,7 @@ module Google attr_accessor :creation_date # Date on which the shipment has been delivered, in ISO 8601 format. Present - # only if status is delivered + # only if `status` is `delivered` # Corresponds to the JSON property `deliveryDate` # @return [String] attr_accessor :delivery_date @@ -5335,10 +5485,10 @@ module Google # The status of the shipment. # Acceptable values are: - # - "delivered" - # - "readyForPickup" - # - "shipped" - # - "undeliverable" + # - "`delivered`" + # - "`readyForPickup`" + # - "`shipped`" + # - "`undeliverable`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -5423,8 +5573,8 @@ module Google # @return [String] attr_accessor :operation_id - # [required] ID of the shipment group. It is assigned by the merchant in the - # shipLineItems method and is used to group multiple line items that have the + # [required] ID of the shipment group. It is assigned by the merchant in the ` + # shipLineItems` method and is used to group multiple line items that have the # same kind of shipping charges. # Corresponds to the JSON property `shipmentGroupId` # @return [String] @@ -5450,8 +5600,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -5488,14 +5638,15 @@ module Google # @return [String] attr_accessor :operation_id - # Option to create a refund-only invoice. Exactly one of refundOnlyOption or - # returnOption must be provided. + # Option to create a refund-only invoice. Exactly one of `refundOnlyOption` or ` + # returnOption` must be provided. # Corresponds to the JSON property `refundOnlyOption` # @return [Google::Apis::ContentV2_1::OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption] attr_accessor :refund_only_option # Option to create an invoice for a refund and mark all items within the invoice - # as returned. Exactly one of refundOnlyOption or returnOption must be provided. + # as returned. Exactly one of `refundOnlyOption` or `returnOption` must be + # provided. # Corresponds to the JSON property `returnOption` # @return [Google::Apis::ContentV2_1::OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption] attr_accessor :return_option @@ -5525,8 +5676,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -5559,50 +5710,50 @@ module Google # [required] Reason for the refund. # Acceptable values are: - # - "adjustment" - # - "autoPostInternal" - # - "autoPostInvalidBillingAddress" - # - "autoPostNoInventory" - # - "autoPostPriceError" - # - "autoPostUndeliverableShippingAddress" - # - "couponAbuse" - # - "courtesyAdjustment" - # - "customerCanceled" - # - "customerDiscretionaryReturn" - # - "customerInitiatedMerchantCancel" - # - "customerSupportRequested" - # - "deliveredLateByCarrier" - # - "deliveredTooLate" - # - "expiredItem" - # - "failToPushOrderGoogleError" - # - "failToPushOrderMerchantError" - # - "failToPushOrderMerchantFulfillmentError" - # - "failToPushOrderToMerchant" - # - "failToPushOrderToMerchantOutOfStock" - # - "feeAdjustment" - # - "invalidCoupon" - # - "lateShipmentCredit" - # - "malformedShippingAddress" - # - "merchantDidNotShipOnTime" - # - "noInventory" - # - "orderTimeout" - # - "other" - # - "paymentAbuse" - # - "paymentDeclined" - # - "priceAdjustment" - # - "priceError" - # - "productArrivedDamaged" - # - "productNotAsDescribed" - # - "promoReallocation" - # - "qualityNotAsExpected" - # - "returnRefundAbuse" - # - "shippingCostAdjustment" - # - "shippingPriceError" - # - "taxAdjustment" - # - "taxError" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" - # - "wrongProductShipped" + # - "`adjustment`" + # - "`autoPostInternal`" + # - "`autoPostInvalidBillingAddress`" + # - "`autoPostNoInventory`" + # - "`autoPostPriceError`" + # - "`autoPostUndeliverableShippingAddress`" + # - "`couponAbuse`" + # - "`courtesyAdjustment`" + # - "`customerCanceled`" + # - "`customerDiscretionaryReturn`" + # - "`customerInitiatedMerchantCancel`" + # - "`customerSupportRequested`" + # - "`deliveredLateByCarrier`" + # - "`deliveredTooLate`" + # - "`expiredItem`" + # - "`failToPushOrderGoogleError`" + # - "`failToPushOrderMerchantError`" + # - "`failToPushOrderMerchantFulfillmentError`" + # - "`failToPushOrderToMerchant`" + # - "`failToPushOrderToMerchantOutOfStock`" + # - "`feeAdjustment`" + # - "`invalidCoupon`" + # - "`lateShipmentCredit`" + # - "`malformedShippingAddress`" + # - "`merchantDidNotShipOnTime`" + # - "`noInventory`" + # - "`orderTimeout`" + # - "`other`" + # - "`paymentAbuse`" + # - "`paymentDeclined`" + # - "`priceAdjustment`" + # - "`priceError`" + # - "`productArrivedDamaged`" + # - "`productNotAsDescribed`" + # - "`promoReallocation`" + # - "`qualityNotAsExpected`" + # - "`returnRefundAbuse`" + # - "`shippingCostAdjustment`" + # - "`shippingPriceError`" + # - "`taxAdjustment`" + # - "`taxError`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" + # - "`wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -5629,19 +5780,19 @@ module Google # [required] Reason for the return. # Acceptable values are: - # - "customerDiscretionaryReturn" - # - "customerInitiatedMerchantCancel" - # - "deliveredTooLate" - # - "expiredItem" - # - "invalidCoupon" - # - "malformedShippingAddress" - # - "other" - # - "productArrivedDamaged" - # - "productNotAsDescribed" - # - "qualityNotAsExpected" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" - # - "wrongProductShipped" + # - "`customerDiscretionaryReturn`" + # - "`customerInitiatedMerchantCancel`" + # - "`deliveredTooLate`" + # - "`expiredItem`" + # - "`invalidCoupon`" + # - "`malformedShippingAddress`" + # - "`other`" + # - "`productArrivedDamaged`" + # - "`productNotAsDescribed`" + # - "`qualityNotAsExpected`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" + # - "`wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -5721,6 +5872,55 @@ module Google end end + # + class OrderreturnsAcknowledgeRequest + include Google::Apis::Core::Hashable + + # [required] The ID of the operation, unique across all operations for a given + # order return. + # Corresponds to the JSON property `operationId` + # @return [String] + attr_accessor :operation_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) + end + end + + # + class OrderreturnsAcknowledgeResponse + include Google::Apis::Core::Hashable + + # The status of the execution. + # Acceptable values are: + # - "`duplicate`" + # - "`executed`" + # Corresponds to the JSON property `executionStatus` + # @return [String] + attr_accessor :execution_status + + # Identifies what kind of resource this is. Value: the fixed string "content# + # orderreturnsAcknowledgeResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @execution_status = args[:execution_status] if args.key?(:execution_status) + @kind = args[:kind] if args.key?(:kind) + end + end + # class OrderreturnsListResponse include Google::Apis::Core::Hashable @@ -5753,6 +5953,196 @@ module Google end end + # + class OrderreturnsPartialRefund + include Google::Apis::Core::Hashable + + # The pre-tax or post-tax amount to be refunded, depending on the location of + # the order. + # Corresponds to the JSON property `priceAmount` + # @return [Google::Apis::ContentV2_1::Price] + attr_accessor :price_amount + + # Tax amount to be refunded. Note: This has different meaning depending on the + # location of the order. + # Corresponds to the JSON property `taxAmount` + # @return [Google::Apis::ContentV2_1::Price] + attr_accessor :tax_amount + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @price_amount = args[:price_amount] if args.key?(:price_amount) + @tax_amount = args[:tax_amount] if args.key?(:tax_amount) + end + end + + # + class OrderreturnsProcessRequest + include Google::Apis::Core::Hashable + + # Option to charge the customer return shipping cost. + # Corresponds to the JSON property `fullChargeReturnShippingCost` + # @return [Boolean] + attr_accessor :full_charge_return_shipping_cost + alias_method :full_charge_return_shipping_cost?, :full_charge_return_shipping_cost + + # [required] The ID of the operation, unique across all operations for a given + # order return. + # Corresponds to the JSON property `operationId` + # @return [String] + attr_accessor :operation_id + + # Refunds for original shipping fee. + # Corresponds to the JSON property `refundShippingFee` + # @return [Google::Apis::ContentV2_1::OrderreturnsRefundOperation] + attr_accessor :refund_shipping_fee + + # The list of items to return. + # Corresponds to the JSON property `returnItems` + # @return [Array] + attr_accessor :return_items + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @full_charge_return_shipping_cost = args[:full_charge_return_shipping_cost] if args.key?(:full_charge_return_shipping_cost) + @operation_id = args[:operation_id] if args.key?(:operation_id) + @refund_shipping_fee = args[:refund_shipping_fee] if args.key?(:refund_shipping_fee) + @return_items = args[:return_items] if args.key?(:return_items) + end + end + + # + class OrderreturnsProcessResponse + include Google::Apis::Core::Hashable + + # The status of the execution. + # Acceptable values are: + # - "`duplicate`" + # - "`executed`" + # Corresponds to the JSON property `executionStatus` + # @return [String] + attr_accessor :execution_status + + # Identifies what kind of resource this is. Value: the fixed string "content# + # orderreturnsProcessResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @execution_status = args[:execution_status] if args.key?(:execution_status) + @kind = args[:kind] if args.key?(:kind) + end + end + + # + class OrderreturnsRefundOperation + include Google::Apis::Core::Hashable + + # If true, the item will be fully refunded. + # Corresponds to the JSON property `fullRefund` + # @return [Boolean] + attr_accessor :full_refund + alias_method :full_refund?, :full_refund + + # If this is set, the item will be partially refunded. + # Corresponds to the JSON property `partialRefund` + # @return [Google::Apis::ContentV2_1::OrderreturnsPartialRefund] + attr_accessor :partial_refund + + # The explanation of the reason. + # Corresponds to the JSON property `reasonText` + # @return [String] + attr_accessor :reason_text + + # Code of the refund reason. + # Corresponds to the JSON property `returnRefundReason` + # @return [String] + attr_accessor :return_refund_reason + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @full_refund = args[:full_refund] if args.key?(:full_refund) + @partial_refund = args[:partial_refund] if args.key?(:partial_refund) + @reason_text = args[:reason_text] if args.key?(:reason_text) + @return_refund_reason = args[:return_refund_reason] if args.key?(:return_refund_reason) + end + end + + # + class OrderreturnsRejectOperation + include Google::Apis::Core::Hashable + + # The reason for the return. + # Corresponds to the JSON property `reason` + # @return [String] + attr_accessor :reason + + # The explanation of the reason. + # Corresponds to the JSON property `reasonText` + # @return [String] + attr_accessor :reason_text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @reason = args[:reason] if args.key?(:reason) + @reason_text = args[:reason_text] if args.key?(:reason_text) + end + end + + # + class OrderreturnsReturnItem + include Google::Apis::Core::Hashable + + # Refunds the item. + # Corresponds to the JSON property `refund` + # @return [Google::Apis::ContentV2_1::OrderreturnsRefundOperation] + attr_accessor :refund + + # Rejects the item. + # Corresponds to the JSON property `reject` + # @return [Google::Apis::ContentV2_1::OrderreturnsRejectOperation] + attr_accessor :reject + + # Unit level ID for the return item. Different units of the same product will + # have different IDs. + # Corresponds to the JSON property `returnItemId` + # @return [String] + attr_accessor :return_item_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @refund = args[:refund] if args.key?(:refund) + @reject = args[:reject] if args.key?(:reject) + @return_item_id = args[:return_item_id] if args.key?(:return_item_id) + end + end + # class OrdersAcknowledgeRequest include Google::Apis::Core::Hashable @@ -5778,8 +6168,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -5848,16 +6238,16 @@ module Google # The reason for the cancellation. # Acceptable values are: - # - "customerInitiatedCancel" - # - "invalidCoupon" - # - "malformedShippingAddress" - # - "noInventory" - # - "other" - # - "priceError" - # - "shippingPriceError" - # - "taxError" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" + # - "`customerInitiatedCancel`" + # - "`invalidCoupon`" + # - "`malformedShippingAddress`" + # - "`noInventory`" + # - "`other`" + # - "`priceError`" + # - "`shippingPriceError`" + # - "`taxError`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -5888,8 +6278,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -5922,16 +6312,16 @@ module Google # The reason for the cancellation. # Acceptable values are: - # - "customerInitiatedCancel" - # - "invalidCoupon" - # - "malformedShippingAddress" - # - "noInventory" - # - "other" - # - "priceError" - # - "shippingPriceError" - # - "taxError" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" + # - "`customerInitiatedCancel`" + # - "`invalidCoupon`" + # - "`malformedShippingAddress`" + # - "`noInventory`" + # - "`other`" + # - "`priceError`" + # - "`shippingPriceError`" + # - "`taxError`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -5959,8 +6349,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -5988,9 +6378,9 @@ module Google # The reason for the cancellation. # Acceptable values are: - # - "changedMind" - # - "orderedWrongItem" - # - "other" + # - "`changedMind`" + # - "`orderedWrongItem`" + # - "`other`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -6030,24 +6420,24 @@ module Google include Google::Apis::Core::Hashable # The CLDR territory code of the country of the test order to create. Affects - # the currency and addresses of orders created via template_name, or the - # addresses of orders created via test_order. + # the currency and addresses of orders created via `template_name`, or the + # addresses of orders created via `test_order`. # Acceptable values are: - # - "US" - # - "FR" Defaults to US. + # - "`US`" + # - "`FR`" Defaults to `US`. # Corresponds to the JSON property `country` # @return [String] attr_accessor :country - # The test order template to use. Specify as an alternative to testOrder as a + # The test order template to use. Specify as an alternative to `testOrder` as a # shortcut for retrieving a template and then creating an order using that # template. # Acceptable values are: - # - "template1" - # - "template1a" - # - "template1b" - # - "template2" - # - "template3" + # - "`template1`" + # - "`template1a`" + # - "`template1b`" + # - "`template2`" + # - "`template3`" # Corresponds to the JSON property `templateName` # @return [String] attr_accessor :template_name @@ -6169,7 +6559,7 @@ module Google class OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo include Google::Apis::Core::Hashable - # The carrier handling the shipment. See shipments[].carrier in the Orders + # The carrier handling the shipment. See `shipments[].carrier` in the Orders # resource representation for a list of acceptable values. # Corresponds to the JSON property `carrier` # @return [String] @@ -6209,7 +6599,8 @@ module Google attr_accessor :kind # Order. Production access (all methods) requires the order manager role. - # Sandbox access does not. + # Sandbox access does not. (== resource_for v2.orders ==) (== resource_for v2.1. + # orders ==) # Corresponds to the JSON property `order` # @return [Google::Apis::ContentV2_1::Order] attr_accessor :order @@ -6284,19 +6675,19 @@ module Google # The reason for the return. # Acceptable values are: - # - "customerDiscretionaryReturn" - # - "customerInitiatedMerchantCancel" - # - "deliveredTooLate" - # - "expiredItem" - # - "invalidCoupon" - # - "malformedShippingAddress" - # - "other" - # - "productArrivedDamaged" - # - "productNotAsDescribed" - # - "qualityNotAsExpected" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" - # - "wrongProductShipped" + # - "`customerDiscretionaryReturn`" + # - "`customerInitiatedMerchantCancel`" + # - "`deliveredTooLate`" + # - "`expiredItem`" + # - "`invalidCoupon`" + # - "`malformedShippingAddress`" + # - "`other`" + # - "`productArrivedDamaged`" + # - "`productNotAsDescribed`" + # - "`qualityNotAsExpected`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" + # - "`wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -6334,8 +6725,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -6416,11 +6807,11 @@ module Google # The reason for the return. # Acceptable values are: - # - "damagedOrUsed" - # - "missingComponent" - # - "notEligible" - # - "other" - # - "outOfReturnWindow" + # - "`damagedOrUsed`" + # - "`missingComponent`" + # - "`notEligible`" + # - "`other`" + # - "`outOfReturnWindow`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -6451,8 +6842,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -6507,19 +6898,19 @@ module Google # The reason for the return. # Acceptable values are: - # - "customerDiscretionaryReturn" - # - "customerInitiatedMerchantCancel" - # - "deliveredTooLate" - # - "expiredItem" - # - "invalidCoupon" - # - "malformedShippingAddress" - # - "other" - # - "productArrivedDamaged" - # - "productNotAsDescribed" - # - "qualityNotAsExpected" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" - # - "wrongProductShipped" + # - "`customerDiscretionaryReturn`" + # - "`customerInitiatedMerchantCancel`" + # - "`deliveredTooLate`" + # - "`expiredItem`" + # - "`invalidCoupon`" + # - "`malformedShippingAddress`" + # - "`other`" + # - "`productArrivedDamaged`" + # - "`productNotAsDescribed`" + # - "`qualityNotAsExpected`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" + # - "`wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -6558,8 +6949,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -6626,8 +7017,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -6694,8 +7085,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -6774,8 +7165,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -6828,8 +7219,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -6855,14 +7246,15 @@ module Google class OrdersUpdateShipmentRequest include Google::Apis::Core::Hashable - # The carrier handling the shipment. Not updated if missing. See shipments[]. - # carrier in the Orders resource representation for a list of acceptable values. + # The carrier handling the shipment. Not updated if missing. See `shipments[]. + # carrier` in the Orders resource representation for a list of acceptable + # values. # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier # Date on which the shipment has been delivered, in ISO 8601 format. Optional - # and can be provided only if status is delivered. + # and can be provided only if `status` is `delivered`. # Corresponds to the JSON property `deliveryDate` # @return [String] attr_accessor :delivery_date @@ -6879,8 +7271,8 @@ module Google # New status for the shipment. Not updated if missing. # Acceptable values are: - # - "delivered" - # - "undeliverable" + # - "`delivered`" + # - "`undeliverable`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -6911,8 +7303,8 @@ module Google # The status of the execution. # Acceptable values are: - # - "duplicate" - # - "executed" + # - "`duplicate`" + # - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -6938,12 +7330,12 @@ module Google class PickupCarrierService include Google::Apis::Core::Hashable - # The name of the pickup carrier (e.g., "UPS"). Required. + # The name of the pickup carrier (e.g., `"UPS"`). Required. # Corresponds to the JSON property `carrierName` # @return [String] attr_accessor :carrier_name - # The name of the pickup service (e.g., "Access point"). Required. + # The name of the pickup service (e.g., `"Access point"`). Required. # Corresponds to the JSON property `serviceName` # @return [String] attr_accessor :service_name @@ -6963,7 +7355,7 @@ module Google class PickupServicesPickupService include Google::Apis::Core::Hashable - # The name of the carrier (e.g., "UPS"). Always present. + # The name of the carrier (e.g., `"UPS"`). Always present. # Corresponds to the JSON property `carrierName` # @return [String] attr_accessor :carrier_name @@ -6973,7 +7365,7 @@ module Google # @return [String] attr_accessor :country - # The name of the pickup service (e.g., "Access point"). Always present. + # The name of the pickup service (e.g., `"Access point"`). Always present. # Corresponds to the JSON property `serviceName` # @return [String] attr_accessor :service_name @@ -7030,11 +7422,11 @@ module Google # The method of the batch entry. # Acceptable values are: - # - "delete" - # - "get" - # - "insert" - # - "inventory" - # - "sale" + # - "`delete`" + # - "`get`" + # - "`insert`" + # - "`inventory`" + # - "`sale`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -7049,7 +7441,7 @@ module Google # @return [Google::Apis::ContentV2_1::PosStore] attr_accessor :store - # The store code. Set this only if the method is delete or get. + # The store code. Set this only if the method is `delete` or `get`. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code @@ -7121,8 +7513,8 @@ module Google # @return [Google::Apis::ContentV2_1::PosInventory] attr_accessor :inventory - # Identifies what kind of resource this is. Value: the fixed string "content# - # posCustomBatchResponseEntry". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # posCustomBatchResponseEntry`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -7227,8 +7619,8 @@ module Google # @return [String] attr_accessor :item_id - # Identifies what kind of resource this is. Value: the fixed string "content# - # posInventory". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # posInventory`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -7243,8 +7635,8 @@ module Google # @return [Fixnum] attr_accessor :quantity - # Required. The identifier of the merchant's store. Either a storeCode inserted - # via the API or the code of the store in Google My Business. + # Required. The identifier of the merchant's store. Either a `storeCode` + # inserted via the API or the code of the store in Google My Business. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code @@ -7306,8 +7698,8 @@ module Google # @return [Fixnum] attr_accessor :quantity - # Required. The identifier of the merchant's store. Either a storeCode inserted - # via the API or the code of the store in Google My Business. + # Required. The identifier of the merchant's store. Either a `storeCode` + # inserted via the API or the code of the store in Google My Business. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code @@ -7374,8 +7766,8 @@ module Google # @return [Fixnum] attr_accessor :quantity - # Required. The identifier of the merchant's store. Either a storeCode inserted - # via the API or the code of the store in Google My Business. + # Required. The identifier of the merchant's store. Either a `storeCode` + # inserted via the API or the code of the store in Google My Business. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code @@ -7453,8 +7845,8 @@ module Google # @return [String] attr_accessor :item_id - # Identifies what kind of resource this is. Value: the fixed string "content# - # posSale". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # posSale`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -7475,8 +7867,8 @@ module Google # @return [String] attr_accessor :sale_id - # Required. The identifier of the merchant's store. Either a storeCode inserted - # via the API or the code of the store in Google My Business. + # Required. The identifier of the merchant's store. Either a `storeCode` + # inserted via the API or the code of the store in Google My Business. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code @@ -7545,8 +7937,8 @@ module Google # @return [String] attr_accessor :sale_id - # Required. The identifier of the merchant's store. Either a storeCode inserted - # via the API or the code of the store in Google My Business. + # Required. The identifier of the merchant's store. Either a `storeCode` + # inserted via the API or the code of the store in Google My Business. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code @@ -7620,8 +8012,8 @@ module Google # @return [String] attr_accessor :sale_id - # Required. The identifier of the merchant's store. Either a storeCode inserted - # via the API or the code of the store in Google My Business. + # Required. The identifier of the merchant's store. Either a `storeCode` + # inserted via the API or the code of the store in Google My Business. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code @@ -7659,8 +8051,8 @@ module Google class PosStore include Google::Apis::Core::Hashable - # Identifies what kind of resource this is. Value: the fixed string "content# - # posStore". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # posStore`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -7723,20 +8115,20 @@ module Google class PostalCodeRange include Google::Apis::Core::Hashable - # A postal code or a pattern of the form prefix* denoting the inclusive lower - # bound of the range defining the area. Examples values: "94108", "9410*", "9*". - # Required. + # A postal code or a pattern of the form `prefix*` denoting the inclusive lower + # bound of the range defining the area. Examples values: `"94108"`, `"9410*"`, `" + # 9*"`. Required. # Corresponds to the JSON property `postalCodeRangeBegin` # @return [String] attr_accessor :postal_code_range_begin - # A postal code or a pattern of the form prefix* denoting the inclusive upper - # bound of the range defining the area. It must have the same length as - # postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then - # postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a - # pattern then postalCodeRangeEnd must be a pattern with the same prefix length. - # Optional: if not set, then the area is defined as being all the postal codes - # matching postalCodeRangeBegin. + # A postal code or a pattern of the form `prefix*` denoting the inclusive upper + # bound of the range defining the area. It must have the same length as ` + # postalCodeRangeBegin`: if `postalCodeRangeBegin` is a postal code then ` + # postalCodeRangeEnd` must be a postal code too; if `postalCodeRangeBegin` is a + # pattern then `postalCodeRangeEnd` must be a pattern with the same prefix + # length. Optional: if not set, then the area is defined as being all the postal + # codes matching `postalCodeRangeBegin`. # Corresponds to the JSON property `postalCodeRangeEnd` # @return [String] attr_accessor :postal_code_range_end @@ -7777,6 +8169,11 @@ module Google end end + # Required product attributes are primarily defined by the products data + # specification. See the Products Data Specification Help Center article for + # information. + # Some attributes are country-specific, so make sure you select the appropriate + # country in the drop-down selector at the top of the page. # Product data. After inserting, updating, or deleting a product, it may take # several minutes before changes take effect. class Product @@ -7832,8 +8229,8 @@ module Google # Required. The item's channel (online or local). # Acceptable values are: - # - "local" - # - "online" + # - "`local`" + # - "`online`" # Corresponds to the JSON property `channel` # @return [String] attr_accessor :channel @@ -7860,7 +8257,7 @@ module Google # A list of custom (merchant-provided) attributes. It can also be used for # submitting any attribute of the feed specification in its generic form (e.g., ` - # "name": "size type", "value": "regular" `). This is useful for submitting + # ` "name": "size type", "value": "regular" ``). This is useful for submitting # attributes not explicitly exposed by the API, such as additional attributes # used for Shopping Actions. # Corresponds to the JSON property `customAttributes` @@ -7934,9 +8331,9 @@ module Google attr_accessor :excluded_destinations # Date on which the item should expire, as specified upon insertion, in ISO 8601 - # format. The actual expiration date in Google Shopping is exposed in - # productstatuses as googleExpirationDate and might be earlier if expirationDate - # is too far in the future. + # format. The actual expiration date in Google Shopping is exposed in ` + # productstatuses` as `googleExpirationDate` and might be earlier if ` + # expirationDate` is too far in the future. # Corresponds to the JSON property `expirationDate` # @return [String] attr_accessor :expiration_date @@ -7957,7 +8354,7 @@ module Google attr_accessor :gtin # The REST ID of the product. Content API methods that operate on products take - # this as their productId parameter. + # this as their `productId` parameter. # The REST ID for a product is of the form channel:contentLanguage:targetCountry: # offerId. # Corresponds to the JSON property `id` @@ -7979,7 +8376,7 @@ module Google # The list of destinations to include for this target (corresponds to checked # check boxes in Merchant Center). Default destinations are always included - # unless provided in excludedDestinations. + # unless provided in `excludedDestinations`. # Corresponds to the JSON property `includedDestinations` # @return [Array] attr_accessor :included_destinations @@ -8001,8 +8398,8 @@ module Google # @return [String] attr_accessor :item_group_id - # Identifies what kind of resource this is. Value: the fixed string "content# - # product". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # product`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -8145,17 +8542,17 @@ module Google attr_accessor :size_type # Size of the item. Only one value is allowed. For variants with different sizes, - # insert a separate product for each size with the same itemGroupId value (see - # size definition). + # insert a separate product for each size with the same `itemGroupId` value ( + # see size definition). # Corresponds to the JSON property `sizes` # @return [Array] attr_accessor :sizes # The source of the offer, i.e., how the offer was created. # Acceptable values are: - # - "api" - # - "crawl" - # - "feed" + # - "`api`" + # - "`crawl`" + # - "`feed`" # Corresponds to the JSON property `source` # @return [String] attr_accessor :source @@ -8446,8 +8843,8 @@ module Google # @return [Array] attr_accessor :item_level_issues - # Identifies what kind of resource this is. Value: the fixed string "content# - # productStatus". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # productStatus`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -8719,21 +9116,26 @@ module Google # The method of the batch entry. # Acceptable values are: - # - "delete" - # - "get" - # - "insert" + # - "`delete`" + # - "`get`" + # - "`insert`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop + # Required product attributes are primarily defined by the products data + # specification. See the Products Data Specification Help Center article for + # information. + # Some attributes are country-specific, so make sure you select the appropriate + # country in the drop-down selector at the top of the page. # Product data. After inserting, updating, or deleting a product, it may take # several minutes before changes take effect. # Corresponds to the JSON property `product` # @return [Google::Apis::ContentV2_1::Product] attr_accessor :product - # The ID of the product to get or delete. Only defined if the method is get or - # delete. + # The ID of the product to get or delete. Only defined if the method is `get` or + # `delete`. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id @@ -8793,12 +9195,17 @@ module Google # @return [Google::Apis::ContentV2_1::Errors] attr_accessor :errors - # Identifies what kind of resource this is. Value: the fixed string "content# - # productsCustomBatchResponseEntry". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # productsCustomBatchResponseEntry`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind + # Required product attributes are primarily defined by the products data + # specification. See the Products Data Specification Help Center article for + # information. + # Some attributes are country-specific, so make sure you select the appropriate + # country in the drop-down selector at the top of the page. # Product data. After inserting, updating, or deleting a product, it may take # several minutes before changes take effect. # Corresponds to the JSON property `product` @@ -8897,7 +9304,7 @@ module Google # The method of the batch entry. # Acceptable values are: - # - "get" + # - "`get`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -8962,8 +9369,8 @@ module Google # @return [Google::Apis::ContentV2_1::Errors] attr_accessor :errors - # Identifies what kind of resource this is. Value: the fixed string "content# - # productstatusesCustomBatchResponseEntry". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # productstatusesCustomBatchResponseEntry`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -9020,7 +9427,8 @@ module Google end # Settings for Pub/Sub notifications, all methods require that the caller is a - # direct user of the merchant center account. + # direct user of the merchant center account. (== resource_for v2.1. + # pubsubnotificationsettings ==) class PubsubNotificationSettings include Google::Apis::Core::Hashable @@ -9029,13 +9437,15 @@ module Google # @return [String] attr_accessor :cloud_topic_name - # Identifies what kind of resource this is. Value: the fixed string "content# - # pubsubNotificationSettings". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # pubsubNotificationSettings`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # List of event types. Supported event types: orderPendingShipment. + # List of event types. + # Acceptable values are: + # - "`orderPendingShipment`" # Corresponds to the JSON property `registeredEvents` # @return [Array] attr_accessor :registered_events @@ -9064,13 +9474,14 @@ module Google # @return [Array] attr_accessor :applicable_shipping_labels - # A list of carrier rates that can be referred to by mainTable or singleValue. + # A list of carrier rates that can be referred to by `mainTable` or `singleValue` + # . # Corresponds to the JSON property `carrierRates` # @return [Array] attr_accessor :carrier_rates - # A table defining the rate group, when singleValue is not expressive enough. - # Can only be set if singleValue is not set. + # A table defining the rate group, when `singleValue` is not expressive enough. + # Can only be set if `singleValue` is not set. # Corresponds to the JSON property `mainTable` # @return [Google::Apis::ContentV2_1::Table] attr_accessor :main_table @@ -9082,14 +9493,14 @@ module Google attr_accessor :name # The single value of a rate group or the value of a rate group table's cell. - # Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, - # subtableName must be set. + # Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, + # `subtableName` must be set. # Corresponds to the JSON property `singleValue` # @return [Google::Apis::ContentV2_1::Value] attr_accessor :single_value - # A list of subtables referred to by mainTable. Can only be set if mainTable is - # set. + # A list of subtables referred to by `mainTable`. Can only be set if `mainTable` + # is set. # Corresponds to the JSON property `subtables` # @return [Array] attr_accessor :subtables @@ -9120,50 +9531,50 @@ module Google # Code of the refund reason. # Acceptable values are: - # - "adjustment" - # - "autoPostInternal" - # - "autoPostInvalidBillingAddress" - # - "autoPostNoInventory" - # - "autoPostPriceError" - # - "autoPostUndeliverableShippingAddress" - # - "couponAbuse" - # - "courtesyAdjustment" - # - "customerCanceled" - # - "customerDiscretionaryReturn" - # - "customerInitiatedMerchantCancel" - # - "customerSupportRequested" - # - "deliveredLateByCarrier" - # - "deliveredTooLate" - # - "expiredItem" - # - "failToPushOrderGoogleError" - # - "failToPushOrderMerchantError" - # - "failToPushOrderMerchantFulfillmentError" - # - "failToPushOrderToMerchant" - # - "failToPushOrderToMerchantOutOfStock" - # - "feeAdjustment" - # - "invalidCoupon" - # - "lateShipmentCredit" - # - "malformedShippingAddress" - # - "merchantDidNotShipOnTime" - # - "noInventory" - # - "orderTimeout" - # - "other" - # - "paymentAbuse" - # - "paymentDeclined" - # - "priceAdjustment" - # - "priceError" - # - "productArrivedDamaged" - # - "productNotAsDescribed" - # - "promoReallocation" - # - "qualityNotAsExpected" - # - "returnRefundAbuse" - # - "shippingCostAdjustment" - # - "shippingPriceError" - # - "taxAdjustment" - # - "taxError" - # - "undeliverableShippingAddress" - # - "unsupportedPoBoxAddress" - # - "wrongProductShipped" + # - "`adjustment`" + # - "`autoPostInternal`" + # - "`autoPostInvalidBillingAddress`" + # - "`autoPostNoInventory`" + # - "`autoPostPriceError`" + # - "`autoPostUndeliverableShippingAddress`" + # - "`couponAbuse`" + # - "`courtesyAdjustment`" + # - "`customerCanceled`" + # - "`customerDiscretionaryReturn`" + # - "`customerInitiatedMerchantCancel`" + # - "`customerSupportRequested`" + # - "`deliveredLateByCarrier`" + # - "`deliveredTooLate`" + # - "`expiredItem`" + # - "`failToPushOrderGoogleError`" + # - "`failToPushOrderMerchantError`" + # - "`failToPushOrderMerchantFulfillmentError`" + # - "`failToPushOrderToMerchant`" + # - "`failToPushOrderToMerchantOutOfStock`" + # - "`feeAdjustment`" + # - "`invalidCoupon`" + # - "`lateShipmentCredit`" + # - "`malformedShippingAddress`" + # - "`merchantDidNotShipOnTime`" + # - "`noInventory`" + # - "`orderTimeout`" + # - "`other`" + # - "`paymentAbuse`" + # - "`paymentDeclined`" + # - "`priceAdjustment`" + # - "`priceError`" + # - "`productArrivedDamaged`" + # - "`productNotAsDescribed`" + # - "`promoReallocation`" + # - "`qualityNotAsExpected`" + # - "`returnRefundAbuse`" + # - "`shippingCostAdjustment`" + # - "`shippingPriceError`" + # - "`taxAdjustment`" + # - "`taxError`" + # - "`undeliverableShippingAddress`" + # - "`unsupportedPoBoxAddress`" + # - "`wrongProductShipped`" # Corresponds to the JSON property `reasonCode` # @return [String] attr_accessor :reason_code @@ -9211,7 +9622,7 @@ module Google # @return [String] attr_accessor :region_id - # The sale price of the product. Mandatory if sale_price_effective_date is + # The sale price of the product. Mandatory if `sale_price_effective_date` is # defined. # Corresponds to the JSON property `salePrice` # @return [Google::Apis::ContentV2_1::Price] @@ -9274,7 +9685,7 @@ module Google # Method of the batch request entry. # Acceptable values are: - # - "insert" + # - "`insert`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -9383,8 +9794,8 @@ module Google # @return [String] attr_accessor :country - # Identifies what kind of resource this is. Value: the fixed string "content# - # returnAddress". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # returnAddress`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -9481,8 +9892,8 @@ module Google # @return [String] attr_accessor :country - # Identifies what kind of resource this is. Value: the fixed string "content# - # returnPolicy". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # returnPolicy`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -9564,10 +9975,10 @@ module Google # living things. A policy of less than 30 days can only be applied to those # items. # Acceptable values are: - # - "lastReturnDate" - # - "lifetimeReturns" - # - "noReturns" - # - "numberOfDaysAfterDelivery" + # - "`lastReturnDate`" + # - "`lifetimeReturns`" + # - "`noReturns`" + # - "`numberOfDaysAfterDelivery`" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -9621,6 +10032,57 @@ module Google end end + # + class ReturnPricingInfo + include Google::Apis::Core::Hashable + + # Default option for whether merchant should charge the customer for return + # shipping costs, based on customer selected return reason and merchant's return + # policy for the items being returned. + # Corresponds to the JSON property `chargeReturnShippingFee` + # @return [Boolean] + attr_accessor :charge_return_shipping_fee + alias_method :charge_return_shipping_fee?, :charge_return_shipping_fee + + # Maximum return shipping costs that may be charged to the customer depending on + # merchant's assessment of the return reason and the merchant's return policy + # for the items being returned. + # Corresponds to the JSON property `maxReturnShippingFee` + # @return [Google::Apis::ContentV2_1::MonetaryAmount] + attr_accessor :max_return_shipping_fee + + # Total amount that can be refunded for the items in this return. It represents + # the total amount received by the merchant for the items, after applying + # merchant coupons. + # Corresponds to the JSON property `refundableItemsTotalAmount` + # @return [Google::Apis::ContentV2_1::MonetaryAmount] + attr_accessor :refundable_items_total_amount + + # Maximum amount that can be refunded for the original shipping fee. + # Corresponds to the JSON property `refundableShippingAmount` + # @return [Google::Apis::ContentV2_1::MonetaryAmount] + attr_accessor :refundable_shipping_amount + + # Total amount already refunded by the merchant. It includes all types of + # refunds (items, shipping, etc.) Not provided if no refund has been applied yet. + # Corresponds to the JSON property `totalRefundedAmount` + # @return [Google::Apis::ContentV2_1::MonetaryAmount] + attr_accessor :total_refunded_amount + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @charge_return_shipping_fee = args[:charge_return_shipping_fee] if args.key?(:charge_return_shipping_fee) + @max_return_shipping_fee = args[:max_return_shipping_fee] if args.key?(:max_return_shipping_fee) + @refundable_items_total_amount = args[:refundable_items_total_amount] if args.key?(:refundable_items_total_amount) + @refundable_shipping_amount = args[:refundable_shipping_amount] if args.key?(:refundable_shipping_amount) + @total_refunded_amount = args[:total_refunded_amount] if args.key?(:total_refunded_amount) + end + end + # class ReturnShipment include Google::Apis::Core::Hashable @@ -9637,9 +10099,9 @@ module Google # Type of the return method. # Acceptable values are: - # - "byMail" - # - "contactCustomerSupport" - # - "returnless" + # - "`byMail`" + # - "`contactCustomerSupport`" + # - "`returnless`" # Corresponds to the JSON property `returnMethodType` # @return [String] attr_accessor :return_method_type @@ -9662,10 +10124,10 @@ module Google # State of the shipment. # Acceptable values are: - # - "completed" - # - "new" - # - "shipped" - # - "undeliverable" + # - "`completed`" + # - "`new`" + # - "`shipped`" + # - "`undeliverable`" # Corresponds to the JSON property `state` # @return [String] attr_accessor :state @@ -9721,9 +10183,9 @@ module Google # Method of the batch request entry. # Acceptable values are: - # - "delete" - # - "get" - # - "insert" + # - "`delete`" + # - "`get`" + # - "`insert`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -9733,7 +10195,7 @@ module Google # @return [Google::Apis::ContentV2_1::ReturnAddress] attr_accessor :return_address - # The return address ID. Set this only if the method is delete or get. + # The return address ID. Set this only if the method is `delete` or `get`. # Corresponds to the JSON property `returnAddressId` # @return [String] attr_accessor :return_address_id @@ -9792,8 +10254,8 @@ module Google # @return [Google::Apis::ContentV2_1::Errors] attr_accessor :errors - # Identifies what kind of resource this is. Value: the fixed string "content# - # returnaddressCustomBatchResponseEntry". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # returnaddressCustomBatchResponseEntry`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -9883,9 +10345,9 @@ module Google # Method of the batch request entry. # Acceptable values are: - # - "delete" - # - "get" - # - "insert" + # - "`delete`" + # - "`get`" + # - "`insert`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -9895,7 +10357,7 @@ module Google # @return [Google::Apis::ContentV2_1::ReturnPolicy] attr_accessor :return_policy - # The return policy ID. Set this only if the method is delete or get. + # The return policy ID. Set this only if the method is `delete` or `get`. # Corresponds to the JSON property `returnPolicyId` # @return [String] attr_accessor :return_policy_id @@ -9954,8 +10416,8 @@ module Google # @return [Google::Apis::ContentV2_1::Errors] attr_accessor :errors - # Identifies what kind of resource this is. Value: the fixed string "content# - # returnpolicyCustomBatchResponseEntry". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # returnpolicyCustomBatchResponseEntry`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -10008,8 +10470,8 @@ module Google class Row include Google::Apis::Core::Hashable - # The list of cells that constitute the row. Must have the same length as - # columnHeaders for two-dimensional tables, a length of 1 for one-dimensional + # The list of cells that constitute the row. Must have the same length as ` + # columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional # tables. Required. # Corresponds to the JSON property `cells` # @return [Array] @@ -10054,43 +10516,49 @@ module Google # Eligibility for this service. # Acceptable values are: - # - "All scenarios" - # - "All scenarios except Shopping Actions" - # - "Shopping Actions" + # - "`All scenarios`" + # - "`All scenarios except Shopping Actions`" + # - "`Shopping Actions`" # Corresponds to the JSON property `eligibility` # @return [String] attr_accessor :eligibility # Minimum order value for this service. If set, indicates that customers will # have to spend at least this amount. All prices within a service must have the - # same currency. + # same currency. Cannot be set together with minimum_order_value_table. # Corresponds to the JSON property `minimumOrderValue` # @return [Google::Apis::ContentV2_1::Price] attr_accessor :minimum_order_value + # Table of per store minimum order values for the pickup fulfillment type. + # Cannot be set together with minimum_order_value. + # Corresponds to the JSON property `minimumOrderValueTable` + # @return [Google::Apis::ContentV2_1::MinimumOrderValueTable] + attr_accessor :minimum_order_value_table + # Free-form name of the service. Must be unique within target account. Required. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The carrier-service pair delivering items to collection points. The list of - # supported pickup services can be retrieved via the getSupportedPickupServices - # method. Required if and only if the service delivery type is pickup. + # supported pickup services can be retrieved via the `getSupportedPickupServices` + # method. Required if and only if the service delivery type is `pickup`. # Corresponds to the JSON property `pickupService` # @return [Google::Apis::ContentV2_1::PickupCarrierService] attr_accessor :pickup_service # Shipping rate group definitions. Only the last one is allowed to have an empty - # applicableShippingLabels, which means "everything else". The other - # applicableShippingLabels must not overlap. + # `applicableShippingLabels`, which means "everything else". The other ` + # applicableShippingLabels` must not overlap. # Corresponds to the JSON property `rateGroups` # @return [Array] attr_accessor :rate_groups # Type of locations this service ships orders to. # Acceptable values are: - # - "delivery" - # - "pickup" + # - "`delivery`" + # - "`pickup`" # Corresponds to the JSON property `shipmentType` # @return [String] attr_accessor :shipment_type @@ -10107,6 +10575,7 @@ module Google @delivery_time = args[:delivery_time] if args.key?(:delivery_time) @eligibility = args[:eligibility] if args.key?(:eligibility) @minimum_order_value = args[:minimum_order_value] if args.key?(:minimum_order_value) + @minimum_order_value_table = args[:minimum_order_value_table] if args.key?(:minimum_order_value_table) @name = args[:name] if args.key?(:name) @pickup_service = args[:pickup_service] if args.key?(:pickup_service) @rate_groups = args[:rate_groups] if args.key?(:rate_groups) @@ -10114,6 +10583,411 @@ module Google end end + # Settlement reports detail order-level and item-level credits and debits + # between you and Google. + class SettlementReport + include Google::Apis::Core::Hashable + + # The end date on which all transactions are included in the report, in ISO 8601 + # format. + # Corresponds to the JSON property `endDate` + # @return [String] + attr_accessor :end_date + + # Identifies what kind of resource this is. Value: the fixed string "`content# + # settlementReport`" + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The residual amount from the previous invoice. This is set only if the + # previous invoices are not paid because of negative balance. + # Corresponds to the JSON property `previousBalance` + # @return [Google::Apis::ContentV2_1::Price] + attr_accessor :previous_balance + + # The ID of the settlement report. + # Corresponds to the JSON property `settlementId` + # @return [String] + attr_accessor :settlement_id + + # The start date on which all transactions are included in the report, in ISO + # 8601 format. + # Corresponds to the JSON property `startDate` + # @return [String] + attr_accessor :start_date + + # The money due to the merchant. + # Corresponds to the JSON property `transferAmount` + # @return [Google::Apis::ContentV2_1::Price] + attr_accessor :transfer_amount + + # Date on which transfer for this payment was initiated by Google, in ISO 8601 + # format. + # Corresponds to the JSON property `transferDate` + # @return [String] + attr_accessor :transfer_date + + # The list of bank identifiers used for the transfer. e.g. Trace ID for Federal + # Automated Clearing House (ACH). This may also be known as the Wire ID. + # Corresponds to the JSON property `transferIds` + # @return [Array] + attr_accessor :transfer_ids + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end_date = args[:end_date] if args.key?(:end_date) + @kind = args[:kind] if args.key?(:kind) + @previous_balance = args[:previous_balance] if args.key?(:previous_balance) + @settlement_id = args[:settlement_id] if args.key?(:settlement_id) + @start_date = args[:start_date] if args.key?(:start_date) + @transfer_amount = args[:transfer_amount] if args.key?(:transfer_amount) + @transfer_date = args[:transfer_date] if args.key?(:transfer_date) + @transfer_ids = args[:transfer_ids] if args.key?(:transfer_ids) + end + end + + # Settlement transactions give a detailed breakdown of the settlement report. (= + # = resource_for v2.1.settlementtransactions ==) + class SettlementTransaction + include Google::Apis::Core::Hashable + + # The amount for the transaction. + # Corresponds to the JSON property `amount` + # @return [Google::Apis::ContentV2_1::SettlementTransactionAmount] + attr_accessor :amount + + # Identifiers of the transaction. + # Corresponds to the JSON property `identifiers` + # @return [Google::Apis::ContentV2_1::SettlementTransactionIdentifiers] + attr_accessor :identifiers + + # Identifies what kind of resource this is. Value: the fixed string "`content# + # settlementTransaction`" + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Details of the transaction. + # Corresponds to the JSON property `transaction` + # @return [Google::Apis::ContentV2_1::SettlementTransactionTransaction] + attr_accessor :transaction + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @amount = args[:amount] if args.key?(:amount) + @identifiers = args[:identifiers] if args.key?(:identifiers) + @kind = args[:kind] if args.key?(:kind) + @transaction = args[:transaction] if args.key?(:transaction) + end + end + + # + class SettlementTransactionAmount + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `commission` + # @return [Google::Apis::ContentV2_1::SettlementTransactionAmountCommission] + attr_accessor :commission + + # The description of the event. + # Acceptable values are: + # - "`taxWithhold`" + # - "`principal`" + # - "`principalAdjustment`" + # - "`shippingFee`" + # - "`merchantRemittedSalesTax`" + # - "`googleRemittedSalesTax`" + # - "`merchantCoupon`" + # - "`merchantCouponTax`" + # - "`merchantRemittedDisposalTax`" + # - "`googleRemittedDisposalTax`" + # - "`merchantRemittedRedemptionFee`" + # - "`googleRemittedRedemptionFee`" + # - "`eeeEcoFee`" + # - "`furnitureEcoFee`" + # - "`copyPrivateFee`" + # - "`eeeEcoFeeCommission`" + # - "`furnitureEcoFeeCommission`" + # - "`copyPrivateFeeCommission`" + # - "`principalRefund`" + # - "`principalRefundTax`" + # - "`itemCommission`" + # - "`adjustmentCommission`" + # - "`shippingFeeCommission`" + # - "`commissionRefund`" + # - "`damaged`" + # - "`damagedOrDefectiveItem`" + # - "`expiredItem`" + # - "`faultyItem`" + # - "`incorrectItemReceived`" + # - "`itemMissing`" + # - "`qualityNotExpected`" + # - "`receivedTooLate`" + # - "`storePackageMissing`" + # - "`transitPackageMissing`" + # - "`unsuccessfulDeliveryUndeliverable`" + # - "`wrongChargeInStore`" + # - "`wrongItem`" + # - "`returns`" + # - "`undeliverable`" + # - "`refundFromMerchant`" + # - "`returnLabelShippingFee`" + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The amount that contributes to the line item price. + # Corresponds to the JSON property `transactionAmount` + # @return [Google::Apis::ContentV2_1::Price] + attr_accessor :transaction_amount + + # The type of the amount. + # Acceptable values are: + # - "`itemPrice`" + # - "`orderPrice`" + # - "`refund`" + # - "`earlyRefund`" + # - "`courtesyRefund`" + # - "`returnRefund`" + # - "`returnLabelShippingFeeAmount`" + # 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) + @commission = args[:commission] if args.key?(:commission) + @description = args[:description] if args.key?(:description) + @transaction_amount = args[:transaction_amount] if args.key?(:transaction_amount) + @type = args[:type] if args.key?(:type) + end + end + + # + class SettlementTransactionAmountCommission + include Google::Apis::Core::Hashable + + # The category of the commission. + # Acceptable values are: + # - "`animalsAndPetSupplies`" + # - "`dogCatFoodAndCatLitter`" + # - "`apparelAndAccessories`" + # - "`shoesHandbagsAndSunglasses`" + # - "`costumesAndAccessories`" + # - "`jewelry`" + # - "`watches`" + # - "`hobbiesArtsAndCrafts`" + # - "`homeAndGarden`" + # - "`entertainmentCollectibles`" + # - "`collectibleCoins`" + # - "`sportsCollectibles`" + # - "`sportingGoods`" + # - "`toysAndGames`" + # - "`musicalInstruments`" + # - "`giftCards`" + # - "`babyAndToddler`" + # - "`babyFoodWipesAndDiapers`" + # - "`businessAndIndustrial`" + # - "`camerasOpticsAndPhotography`" + # - "`consumerElectronics`" + # - "`electronicsAccessories`" + # - "`personalComputers`" + # - "`videoGameConsoles`" + # - "`foodAndGrocery`" + # - "`beverages`" + # - "`tobaccoProducts`" + # - "`furniture`" + # - "`hardware`" + # - "`buildingMaterials`" + # - "`tools`" + # - "`healthAndPersonalCare`" + # - "`beauty`" + # - "`householdSupplies`" + # - "`kitchenAndDining`" + # - "`majorAppliances`" + # - "`luggageAndBags`" + # - "`media`" + # - "`officeSupplies`" + # - "`softwareAndVideoGames`" + # - "`vehiclePartsAndAccessories`" + # - "`vehicleTiresAndWheels`" + # - "`vehicles`" + # - "`everythingElse`" + # Corresponds to the JSON property `category` + # @return [String] + attr_accessor :category + + # Rate of the commission in percentage. + # Corresponds to the JSON property `rate` + # @return [String] + attr_accessor :rate + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @category = args[:category] if args.key?(:category) + @rate = args[:rate] if args.key?(:rate) + end + end + + # + class SettlementTransactionIdentifiers + include Google::Apis::Core::Hashable + + # The identifier of the adjustments, if it is available. + # Corresponds to the JSON property `adjustmentId` + # @return [String] + attr_accessor :adjustment_id + + # The merchant provided order ID. + # Corresponds to the JSON property `merchantOrderId` + # @return [String] + attr_accessor :merchant_order_id + + # The unique ID of the settlement transaction entry. + # Corresponds to the JSON property `settlementEntryId` + # @return [String] + attr_accessor :settlement_entry_id + + # The shipment ids for the item. + # Corresponds to the JSON property `shipmentIds` + # @return [Array] + attr_accessor :shipment_ids + + # The Google transaction ID. + # Corresponds to the JSON property `transactionId` + # @return [String] + attr_accessor :transaction_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @adjustment_id = args[:adjustment_id] if args.key?(:adjustment_id) + @merchant_order_id = args[:merchant_order_id] if args.key?(:merchant_order_id) + @settlement_entry_id = args[:settlement_entry_id] if args.key?(:settlement_entry_id) + @shipment_ids = args[:shipment_ids] if args.key?(:shipment_ids) + @transaction_id = args[:transaction_id] if args.key?(:transaction_id) + end + end + + # + class SettlementTransactionTransaction + include Google::Apis::Core::Hashable + + # The time on which the event occurred in ISO 8601 format. + # Corresponds to the JSON property `postDate` + # @return [String] + attr_accessor :post_date + + # The type of the transaction that occurred. + # Acceptable values are: + # - "`order`" + # - "`reversal`" + # - "`orderRefund`" + # - "`reversalRefund`" + # - "`issueRelatedRefundAndReplacement`" + # - "`returnLabelShippingFeeTransaction`" + # - "`reversalIssueRelatedRefundAndReplacement`" + # - "`reversalReturnLabelShippingFeeTransaction`" + # 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) + @post_date = args[:post_date] if args.key?(:post_date) + @type = args[:type] if args.key?(:type) + end + end + + # + class SettlementreportsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string "content# + # settlementreportsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The token for the retrieval of the next page of returns. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # + # Corresponds to the JSON property `resources` + # @return [Array] + attr_accessor :resources + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @resources = args[:resources] if args.key?(:resources) + end + end + + # + class SettlementtransactionsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string "content# + # settlementtransactionsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The token for the retrieval of the next page of returns. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # + # Corresponds to the JSON property `resources` + # @return [Array] + attr_accessor :resources + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @resources = args[:resources] if args.key?(:resources) + end + end + # class ShipmentInvoice include Google::Apis::Core::Hashable @@ -10128,8 +11002,8 @@ module Google # @return [Array] attr_accessor :line_item_invoices - # [required] ID of the shipment group. It is assigned by the merchant in the - # shipLineItems method and is used to group multiple line items that have the + # [required] ID of the shipment group. It is assigned by the merchant in the ` + # shipLineItems` method and is used to group multiple line items that have the # same kind of shipping charges. # Corresponds to the JSON property `shipmentGroupId` # @return [String] @@ -10194,36 +11068,36 @@ module Google # The shipping carrier that handles the package. # Acceptable values are: - # - "boxtal" - # - "bpost" - # - "chronopost" - # - "colisPrive" - # - "colissimo" - # - "cxt" - # - "deliv" - # - "dhl" - # - "dpd" - # - "dynamex" - # - "eCourier" - # - "easypost" - # - "efw" - # - "fedex" - # - "fedexSmartpost" - # - "geodis" - # - "gls" - # - "googleCourier" - # - "gsx" - # - "jdLogistics" - # - "laPoste" - # - "lasership" - # - "manual" - # - "mpx" - # - "onTrac" - # - "other" - # - "tnt" - # - "uds" - # - "ups" - # - "usps" + # - "`boxtal`" + # - "`bpost`" + # - "`chronopost`" + # - "`colisPrive`" + # - "`colissimo`" + # - "`cxt`" + # - "`deliv`" + # - "`dhl`" + # - "`dpd`" + # - "`dynamex`" + # - "`eCourier`" + # - "`easypost`" + # - "`efw`" + # - "`fedex`" + # - "`fedexSmartpost`" + # - "`geodis`" + # - "`gls`" + # - "`googleCourier`" + # - "`gsx`" + # - "`jdLogistics`" + # - "`laPoste`" + # - "`lasership`" + # - "`manual`" + # - "`mpx`" + # - "`onTrac`" + # - "`other`" + # - "`tnt`" + # - "`uds`" + # - "`ups`" + # - "`usps`" # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier @@ -10255,7 +11129,7 @@ module Google # @return [Fixnum] attr_accessor :account_id - # A list of postal code groups that can be referred to in services. Optional. + # A list of postal code groups that can be referred to in `services`. Optional. # Corresponds to the JSON property `postalCodeGroups` # @return [Array] attr_accessor :postal_code_groups @@ -10317,8 +11191,8 @@ module Google # The method of the batch entry. # Acceptable values are: - # - "get" - # - "update" + # - "`get`" + # - "`update`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -10383,8 +11257,8 @@ module Google # @return [Google::Apis::ContentV2_1::Errors] attr_accessor :errors - # Identifies what kind of resource this is. Value: the fixed string "content# - # shippingsettingsCustomBatchResponseEntry". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # shippingsettingsCustomBatchResponseEntry`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -10522,8 +11396,8 @@ module Google class Table include Google::Apis::Core::Hashable - # A non-empty list of row or column headers for a table. Exactly one of prices, - # weights, numItems, postalCodeGroupNames, or location must be set. + # A non-empty list of row or column headers for a table. Exactly one of `prices`, + # `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Corresponds to the JSON property `columnHeaders` # @return [Google::Apis::ContentV2_1::Headers] attr_accessor :column_headers @@ -10533,14 +11407,14 @@ module Google # @return [String] attr_accessor :name - # A non-empty list of row or column headers for a table. Exactly one of prices, - # weights, numItems, postalCodeGroupNames, or location must be set. + # A non-empty list of row or column headers for a table. Exactly one of `prices`, + # `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Corresponds to the JSON property `rowHeaders` # @return [Google::Apis::ContentV2_1::Headers] attr_accessor :row_headers - # The list of rows that constitute the table. Must have the same length as - # rowHeaders. Required. + # The list of rows that constitute the table. Must have the same length as ` + # rowHeaders`. Required. # Corresponds to the JSON property `rows` # @return [Array] attr_accessor :rows @@ -10568,8 +11442,8 @@ module Google attr_accessor :enable_orderinvoices alias_method :enable_orderinvoices?, :enable_orderinvoices - # Identifies what kind of resource this is. Value: the fixed string "content# - # testOrder". + # Identifies what kind of resource this is. Value: the fixed string "`content# + # testOrder`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -10579,20 +11453,16 @@ module Google # @return [Array] attr_accessor :line_items - # Determines if test order must be pulled by merchant or pushed to merchant via - # push integration. - # Acceptable values are: - # - "checkoutIntegration" - # - "merchantPull" + # Restricted. Do not use. # Corresponds to the JSON property `notificationMode` # @return [String] attr_accessor :notification_mode # Required. The billing address. # Acceptable values are: - # - "dwight" - # - "jim" - # - "pam" + # - "`dwight`" + # - "`jim`" + # - "`pam`" # Corresponds to the JSON property `predefinedBillingAddress` # @return [String] attr_accessor :predefined_billing_address @@ -10600,28 +11470,28 @@ module Google # Required. Identifier of one of the predefined delivery addresses for the # delivery. # Acceptable values are: - # - "dwight" - # - "jim" - # - "pam" + # - "`dwight`" + # - "`jim`" + # - "`pam`" # Corresponds to the JSON property `predefinedDeliveryAddress` # @return [String] attr_accessor :predefined_delivery_address # Required. Email address of the customer. # Acceptable values are: - # - "pog.dwight.schrute@gmail.com" - # - "pog.jim.halpert@gmail.com" - # - "penpog.pam.beesly@gmail.comding" + # - "`pog.dwight.schrute@gmail.com`" + # - "`pog.jim.halpert@gmail.com`" + # - "`penpog.pam.beesly@gmail.comding`" # Corresponds to the JSON property `predefinedEmail` # @return [String] attr_accessor :predefined_email # Identifier of one of the predefined pickup details. Required for orders - # containing line items with shipping type pickup. + # containing line items with shipping type `pickup`. # Acceptable values are: - # - "dwight" - # - "jim" - # - "pam" + # - "`dwight`" + # - "`jim`" + # - "`pam`" # Corresponds to the JSON property `predefinedPickupDetails` # @return [String] attr_accessor :predefined_pickup_details @@ -10641,12 +11511,12 @@ module Google # Required. The requested shipping option. # Acceptable values are: - # - "economy" - # - "expedited" - # - "oneDay" - # - "sameDay" - # - "standard" - # - "twoDay" + # - "`economy`" + # - "`expedited`" + # - "`oneDay`" + # - "`sameDay`" + # - "`standard`" + # - "`twoDay`" # Corresponds to the JSON property `shippingOption` # @return [String] attr_accessor :shipping_option @@ -10719,15 +11589,15 @@ module Google # Required. Condition or state of the item. # Acceptable values are: - # - "new" + # - "`new`" # Corresponds to the JSON property `condition` # @return [String] attr_accessor :condition # Required. The two-letter ISO 639-1 language code for the item. # Acceptable values are: - # - "en" - # - "fr" + # - "`en`" + # - "`fr`" # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language @@ -10810,9 +11680,9 @@ module Google class TransitTable include Google::Apis::Core::Hashable - # A list of postal group names. The last value can be "all other locations". - # Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code - # groups must match the delivery country of the service. + # A list of postal group names. The last value can be `"all other locations"`. + # Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal + # code groups must match the delivery country of the service. # Corresponds to the JSON property `postalCodeGroupNames` # @return [Array] attr_accessor :postal_code_group_names @@ -10822,8 +11692,8 @@ module Google # @return [Array] attr_accessor :rows - # A list of transit time labels. The last value can be "all other labels". - # Example: ["food", "electronics", "all other labels"]. + # A list of transit time labels. The last value can be `"all other labels"`. + # Example: `["food", "electronics", "all other labels"]`. # Corresponds to the JSON property `transitTimeLabels` # @return [Array] attr_accessor :transit_time_labels @@ -10863,7 +11733,7 @@ module Google class TransitTableTransitTimeRowTransitTimeValue include Google::Apis::Core::Hashable - # Must be greater than or equal to minTransitTimeInDays. + # Must be greater than or equal to `minTransitTimeInDays`. # Corresponds to the JSON property `maxTransitTimeInDays` # @return [Fixnum] attr_accessor :max_transit_time_in_days @@ -10928,7 +11798,7 @@ module Google # [required] Type of the additional charge. # Acceptable values are: - # - "shipping" + # - "`shipping`" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -10953,17 +11823,17 @@ module Google # @return [Google::Apis::ContentV2_1::Price] attr_accessor :tax_amount - # Optional name of the tax type. This should only be provided if taxType is - # otherFeeTax. + # Optional name of the tax type. This should only be provided if `taxType` is ` + # otherFeeTax`. # Corresponds to the JSON property `taxName` # @return [String] attr_accessor :tax_name # [required] Type of the tax. # Acceptable values are: - # - "otherFee" - # - "otherFeeTax" - # - "sales" + # - "`otherFee`" + # - "`otherFeeTax`" + # - "`sales`" # Corresponds to the JSON property `taxType` # @return [String] attr_accessor :tax_type @@ -10981,8 +11851,8 @@ module Google end # The single value of a rate group or the value of a rate group table's cell. - # Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, - # subtableName must be set. + # Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, + # `subtableName` must be set. class Value include Google::Apis::Core::Hashable @@ -11004,8 +11874,8 @@ module Google attr_accessor :no_shipping alias_method :no_shipping?, :no_shipping - # A percentage of the price represented as a number in decimal notation (e.g., " - # 5.4"). Can only be set if all other fields are not set. + # A percentage of the price represented as a number in decimal notation (e.g., `" + # 5.4"`). Can only be set if all other fields are not set. # Corresponds to the JSON property `pricePercentage` # @return [String] attr_accessor :price_percentage @@ -11036,8 +11906,8 @@ module Google # Required. The weight unit. # Acceptable values are: - # - "kg" - # - "lb" + # - "`kg`" + # - "`lb`" # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit diff --git a/generated/google/apis/content_v2_1/representations.rb b/generated/google/apis/content_v2_1/representations.rb index aa4f55d54..604191cbd 100644 --- a/generated/google/apis/content_v2_1/representations.rb +++ b/generated/google/apis/content_v2_1/representations.rb @@ -628,6 +628,30 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class MerchantRejectionReason + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MinimumOrderValueTable + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MinimumOrderValueTableStoreCodeSetWithMov + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MonetaryAmount + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Order class Representation < Google::Apis::Core::JsonRepresentation; end @@ -832,12 +856,60 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class OrderreturnsAcknowledgeRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OrderreturnsAcknowledgeResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class OrderreturnsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class OrderreturnsPartialRefund + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OrderreturnsProcessRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OrderreturnsProcessResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OrderreturnsRefundOperation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OrderreturnsRejectOperation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OrderreturnsReturnItem + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class OrdersAcknowledgeRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1360,6 +1432,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ReturnPricingInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ReturnShipment class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1438,6 +1516,54 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class SettlementReport + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SettlementTransaction + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SettlementTransactionAmount + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SettlementTransactionAmountCommission + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SettlementTransactionIdentifiers + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SettlementTransactionTransaction + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SettlementreportsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SettlementtransactionsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ShipmentInvoice class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1646,6 +1772,7 @@ module Google class AccountGoogleMyBusinessLink # @private class Representation < Google::Apis::Core::JsonRepresentation + property :gmb_account_id, as: 'gmbAccountId' property :gmb_email, as: 'gmbEmail' property :status, as: 'status' end @@ -2624,6 +2751,8 @@ module Google property :order_return_id, as: 'orderReturnId' collection :return_items, as: 'returnItems', class: Google::Apis::ContentV2_1::MerchantOrderReturnItem, decorator: Google::Apis::ContentV2_1::MerchantOrderReturnItem::Representation + property :return_pricing_info, as: 'returnPricingInfo', class: Google::Apis::ContentV2_1::ReturnPricingInfo, decorator: Google::Apis::ContentV2_1::ReturnPricingInfo::Representation + collection :return_shipments, as: 'returnShipments', class: Google::Apis::ContentV2_1::ReturnShipment, decorator: Google::Apis::ContentV2_1::ReturnShipment::Representation end @@ -2635,15 +2764,57 @@ module Google property :customer_return_reason, as: 'customerReturnReason', class: Google::Apis::ContentV2_1::CustomerReturnReason, decorator: Google::Apis::ContentV2_1::CustomerReturnReason::Representation property :item_id, as: 'itemId' + property :merchant_rejection_reason, as: 'merchantRejectionReason', class: Google::Apis::ContentV2_1::MerchantRejectionReason, decorator: Google::Apis::ContentV2_1::MerchantRejectionReason::Representation + property :merchant_return_reason, as: 'merchantReturnReason', class: Google::Apis::ContentV2_1::RefundReason, decorator: Google::Apis::ContentV2_1::RefundReason::Representation property :product, as: 'product', class: Google::Apis::ContentV2_1::OrderLineItemProduct, decorator: Google::Apis::ContentV2_1::OrderLineItemProduct::Representation + property :refundable_amount, as: 'refundableAmount', class: Google::Apis::ContentV2_1::MonetaryAmount, decorator: Google::Apis::ContentV2_1::MonetaryAmount::Representation + + property :return_item_id, as: 'returnItemId' collection :return_shipment_ids, as: 'returnShipmentIds' + property :shipment_group_id, as: 'shipmentGroupId' + property :shipment_unit_id, as: 'shipmentUnitId' property :state, as: 'state' end end + class MerchantRejectionReason + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :reason_code, as: 'reasonCode' + end + end + + class MinimumOrderValueTable + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :store_code_set_with_movs, as: 'storeCodeSetWithMovs', class: Google::Apis::ContentV2_1::MinimumOrderValueTableStoreCodeSetWithMov, decorator: Google::Apis::ContentV2_1::MinimumOrderValueTableStoreCodeSetWithMov::Representation + + end + end + + class MinimumOrderValueTableStoreCodeSetWithMov + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :store_codes, as: 'storeCodes' + property :value, as: 'value', class: Google::Apis::ContentV2_1::Price, decorator: Google::Apis::ContentV2_1::Price::Representation + + end + end + + class MonetaryAmount + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :price_amount, as: 'priceAmount', class: Google::Apis::ContentV2_1::Price, decorator: Google::Apis::ContentV2_1::Price::Representation + + property :tax_amount, as: 'taxAmount', class: Google::Apis::ContentV2_1::Price, decorator: Google::Apis::ContentV2_1::Price::Representation + + end + end + class Order # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -3075,6 +3246,21 @@ module Google end end + class OrderreturnsAcknowledgeRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :operation_id, as: 'operationId' + end + end + + class OrderreturnsAcknowledgeResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :execution_status, as: 'executionStatus' + property :kind, as: 'kind' + end + end + class OrderreturnsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -3085,6 +3271,66 @@ module Google end end + class OrderreturnsPartialRefund + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :price_amount, as: 'priceAmount', class: Google::Apis::ContentV2_1::Price, decorator: Google::Apis::ContentV2_1::Price::Representation + + property :tax_amount, as: 'taxAmount', class: Google::Apis::ContentV2_1::Price, decorator: Google::Apis::ContentV2_1::Price::Representation + + end + end + + class OrderreturnsProcessRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :full_charge_return_shipping_cost, as: 'fullChargeReturnShippingCost' + property :operation_id, as: 'operationId' + property :refund_shipping_fee, as: 'refundShippingFee', class: Google::Apis::ContentV2_1::OrderreturnsRefundOperation, decorator: Google::Apis::ContentV2_1::OrderreturnsRefundOperation::Representation + + collection :return_items, as: 'returnItems', class: Google::Apis::ContentV2_1::OrderreturnsReturnItem, decorator: Google::Apis::ContentV2_1::OrderreturnsReturnItem::Representation + + end + end + + class OrderreturnsProcessResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :execution_status, as: 'executionStatus' + property :kind, as: 'kind' + end + end + + class OrderreturnsRefundOperation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :full_refund, as: 'fullRefund' + property :partial_refund, as: 'partialRefund', class: Google::Apis::ContentV2_1::OrderreturnsPartialRefund, decorator: Google::Apis::ContentV2_1::OrderreturnsPartialRefund::Representation + + property :reason_text, as: 'reasonText' + property :return_refund_reason, as: 'returnRefundReason' + end + end + + class OrderreturnsRejectOperation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :reason, as: 'reason' + property :reason_text, as: 'reasonText' + end + end + + class OrderreturnsReturnItem + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :refund, as: 'refund', class: Google::Apis::ContentV2_1::OrderreturnsRefundOperation, decorator: Google::Apis::ContentV2_1::OrderreturnsRefundOperation::Representation + + property :reject, as: 'reject', class: Google::Apis::ContentV2_1::OrderreturnsRejectOperation, decorator: Google::Apis::ContentV2_1::OrderreturnsRejectOperation::Representation + + property :return_item_id, as: 'returnItemId' + end + end + class OrdersAcknowledgeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -4083,6 +4329,21 @@ module Google end end + class ReturnPricingInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :charge_return_shipping_fee, as: 'chargeReturnShippingFee' + property :max_return_shipping_fee, as: 'maxReturnShippingFee', class: Google::Apis::ContentV2_1::MonetaryAmount, decorator: Google::Apis::ContentV2_1::MonetaryAmount::Representation + + property :refundable_items_total_amount, as: 'refundableItemsTotalAmount', class: Google::Apis::ContentV2_1::MonetaryAmount, decorator: Google::Apis::ContentV2_1::MonetaryAmount::Representation + + property :refundable_shipping_amount, as: 'refundableShippingAmount', class: Google::Apis::ContentV2_1::MonetaryAmount, decorator: Google::Apis::ContentV2_1::MonetaryAmount::Representation + + property :total_refunded_amount, as: 'totalRefundedAmount', class: Google::Apis::ContentV2_1::MonetaryAmount, decorator: Google::Apis::ContentV2_1::MonetaryAmount::Representation + + end + end + class ReturnShipment # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -4217,6 +4478,8 @@ module Google property :eligibility, as: 'eligibility' property :minimum_order_value, as: 'minimumOrderValue', class: Google::Apis::ContentV2_1::Price, decorator: Google::Apis::ContentV2_1::Price::Representation + property :minimum_order_value_table, as: 'minimumOrderValueTable', class: Google::Apis::ContentV2_1::MinimumOrderValueTable, decorator: Google::Apis::ContentV2_1::MinimumOrderValueTable::Representation + property :name, as: 'name' property :pickup_service, as: 'pickupService', class: Google::Apis::ContentV2_1::PickupCarrierService, decorator: Google::Apis::ContentV2_1::PickupCarrierService::Representation @@ -4226,6 +4489,94 @@ module Google end end + class SettlementReport + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_date, as: 'endDate' + property :kind, as: 'kind' + property :previous_balance, as: 'previousBalance', class: Google::Apis::ContentV2_1::Price, decorator: Google::Apis::ContentV2_1::Price::Representation + + property :settlement_id, as: 'settlementId' + property :start_date, as: 'startDate' + property :transfer_amount, as: 'transferAmount', class: Google::Apis::ContentV2_1::Price, decorator: Google::Apis::ContentV2_1::Price::Representation + + property :transfer_date, as: 'transferDate' + collection :transfer_ids, as: 'transferIds' + end + end + + class SettlementTransaction + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :amount, as: 'amount', class: Google::Apis::ContentV2_1::SettlementTransactionAmount, decorator: Google::Apis::ContentV2_1::SettlementTransactionAmount::Representation + + property :identifiers, as: 'identifiers', class: Google::Apis::ContentV2_1::SettlementTransactionIdentifiers, decorator: Google::Apis::ContentV2_1::SettlementTransactionIdentifiers::Representation + + property :kind, as: 'kind' + property :transaction, as: 'transaction', class: Google::Apis::ContentV2_1::SettlementTransactionTransaction, decorator: Google::Apis::ContentV2_1::SettlementTransactionTransaction::Representation + + end + end + + class SettlementTransactionAmount + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :commission, as: 'commission', class: Google::Apis::ContentV2_1::SettlementTransactionAmountCommission, decorator: Google::Apis::ContentV2_1::SettlementTransactionAmountCommission::Representation + + property :description, as: 'description' + property :transaction_amount, as: 'transactionAmount', class: Google::Apis::ContentV2_1::Price, decorator: Google::Apis::ContentV2_1::Price::Representation + + property :type, as: 'type' + end + end + + class SettlementTransactionAmountCommission + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :category, as: 'category' + property :rate, as: 'rate' + end + end + + class SettlementTransactionIdentifiers + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :adjustment_id, as: 'adjustmentId' + property :merchant_order_id, as: 'merchantOrderId' + property :settlement_entry_id, as: 'settlementEntryId' + collection :shipment_ids, as: 'shipmentIds' + property :transaction_id, as: 'transactionId' + end + end + + class SettlementTransactionTransaction + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :post_date, as: 'postDate' + property :type, as: 'type' + end + end + + class SettlementreportsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :resources, as: 'resources', class: Google::Apis::ContentV2_1::SettlementReport, decorator: Google::Apis::ContentV2_1::SettlementReport::Representation + + end + end + + class SettlementtransactionsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :resources, as: 'resources', class: Google::Apis::ContentV2_1::SettlementTransaction, decorator: Google::Apis::ContentV2_1::SettlementTransaction::Representation + + end + end + class ShipmentInvoice # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/content_v2_1/service.rb b/generated/google/apis/content_v2_1/service.rb index 72a166d96..2f7c234f3 100644 --- a/generated/google/apis/content_v2_1/service.rb +++ b/generated/google/apis/content_v2_1/service.rb @@ -85,13 +85,13 @@ module Google # Claims the website of a Merchant Center sub-account. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account whose website is claimed. # @param [Boolean] overwrite - # Only available to selected merchants. When set to True, this flag removes any - # existing claim on the requested website by another account and replaces it + # Only available to selected merchants. When set to `True`, this flag removes + # any existing claim on the requested website by another account and replaces it # with a claim from this account. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -200,8 +200,8 @@ module Google # Retrieves a Merchant Center account. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account. # @param [String] fields @@ -275,8 +275,8 @@ module Google # accountId and linkedAccountId. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account that should be linked. # @param [Google::Apis::ContentV2_1::AccountsLinkRequest] accounts_link_request_object @@ -355,8 +355,8 @@ module Google # Returns the list of accounts linked to your Merchant Center account. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which to list links. # @param [Fixnum] max_results @@ -399,8 +399,8 @@ module Google # Updates a Merchant Center account. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account. # @param [Google::Apis::ContentV2_1::Account] account_object @@ -474,8 +474,8 @@ module Google # returned for multi-client accounts. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account. # @param [Array, String] destinations @@ -593,8 +593,8 @@ module Google # Retrieves the tax settings of the account. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which to get/update account tax settings. # @param [String] fields @@ -670,8 +670,8 @@ module Google # Updates the tax settings of the account. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which to get/update account tax settings. # @param [Google::Apis::ContentV2_1::AccountTax] account_tax_object @@ -1127,8 +1127,8 @@ module Google # Retrieves the LIA settings of the account. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which to get or update LIA settings. # @param [String] fields @@ -1165,8 +1165,8 @@ module Google # Retrieves the list of accessible Google My Business accounts. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which to retrieve accessible Google My Business # accounts. @@ -1274,8 +1274,8 @@ module Google # Requests access to a specified Google My Business account. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which GMB access is requested. # @param [String] gmb_email @@ -1315,8 +1315,8 @@ module Google # Requests inventory validation for the specified country. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account that manages the order. This cannot be a multi-client # account. @@ -1357,8 +1357,8 @@ module Google # Sets the inventory verification contract for the specified country. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account that manages the order. This cannot be a multi-client # account. @@ -1408,8 +1408,8 @@ module Google # Sets the POS data provider for the specified country. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which to retrieve accessible Google My Business # accounts. @@ -1456,8 +1456,8 @@ module Google # Updates the LIA settings of the account. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which to get or update LIA settings. # @param [Google::Apis::ContentV2_1::LiaSettings] lia_settings_object @@ -1610,7 +1610,7 @@ module Google # Creates a refund invoice for one or more shipment groups, and triggers a # refund for orderinvoice enabled orders. This can only be used for line items - # that have previously been charged using createChargeInvoice. All amounts ( + # that have previously been charged using `createChargeInvoice`. All amounts ( # except for the summary) are incremental with respect to the previous invoice. # @param [Fixnum] merchant_id # The ID of the account that manages the order. This cannot be a multi-client @@ -1749,6 +1749,46 @@ module Google execute_or_queue_command(command, &block) end + # Acks an order return in your Merchant Center account. + # @param [Fixnum] merchant_id + # The ID of the account that manages the order. This cannot be a multi-client + # account. + # @param [String] return_id + # The ID of the return. + # @param [Google::Apis::ContentV2_1::OrderreturnsAcknowledgeRequest] orderreturns_acknowledge_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ContentV2_1::OrderreturnsAcknowledgeResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ContentV2_1::OrderreturnsAcknowledgeResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def acknowledge_orderreturn(merchant_id, return_id, orderreturns_acknowledge_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{merchantId}/orderreturns/{returnId}/acknowledge', options) + command.request_representation = Google::Apis::ContentV2_1::OrderreturnsAcknowledgeRequest::Representation + command.request_object = orderreturns_acknowledge_request_object + command.response_representation = Google::Apis::ContentV2_1::OrderreturnsAcknowledgeResponse::Representation + command.response_class = Google::Apis::ContentV2_1::OrderreturnsAcknowledgeResponse + command.params['merchantId'] = merchant_id unless merchant_id.nil? + command.params['returnId'] = return_id unless return_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Retrieves an order return from your Merchant Center account. # @param [Fixnum] merchant_id # The ID of the account that manages the order. This cannot be a multi-client @@ -1790,12 +1830,26 @@ module Google # @param [Fixnum] merchant_id # The ID of the account that manages the order. This cannot be a multi-client # account. + # @param [Boolean] acknowledged + # Obtains order returns that match the acknowledgement status. When set to true, + # obtains order returns that have been acknowledged. When false, obtains order + # returns that have not been acknowledged. When not provided, obtains order + # returns regardless of their acknowledgement status. + # We recommend using this filter set to `false`, in conjunction with the ` + # acknowledge` call, such that only un-acknowledged order returns are returned. # @param [String] created_end_date # Obtains order returns created before this date (inclusively), in ISO 8601 # format. # @param [String] created_start_date # Obtains order returns created after this date (inclusively), in ISO 8601 # format. + # @param [Array, String] google_order_ids + # Obtains order returns with the specified order ids. If this parameter is + # provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, + # shipmentState and acknowledged parameters must be not set. + # Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the + # obtained results will include all order returns that either match the + # specified order id or the specified tracking number. # @param [Fixnum] max_results # The maximum number of order returns to return in the response, used for paging. # The default value is 25 returns per page, and the maximum allowed value is @@ -1804,6 +1858,25 @@ module Google # Return the results in the specified order. # @param [String] page_token # The token returned by the previous request. + # @param [Array, String] shipment_states + # Obtains order returns that match any shipment state provided in this parameter. + # When this parameter is not provided, order returns are obtained regardless of + # their shipment states. + # @param [Array, String] shipment_status + # Obtains order returns that match any shipment status provided in this + # parameter. When this parameter is not provided, order returns are obtained + # regardless of their shipment statuses. + # @param [Array, String] shipment_tracking_numbers + # Obtains order returns with the specified tracking numbers. If this parameter + # is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, + # shipmentState and acknowledged parameters must be not set. + # Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the + # obtained results will include all order returns that either match the + # specified order id or the specified tracking number. + # @param [Array, String] shipment_types + # Obtains order returns that match any shipment type provided in this parameter. + # When this parameter is not provided, order returns are obtained regardless of + # their shipment types. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1823,16 +1896,62 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_orderreturns(merchant_id, created_end_date: nil, created_start_date: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_orderreturns(merchant_id, acknowledged: nil, created_end_date: nil, created_start_date: nil, google_order_ids: nil, max_results: nil, order_by: nil, page_token: nil, shipment_states: nil, shipment_status: nil, shipment_tracking_numbers: nil, shipment_types: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{merchantId}/orderreturns', options) command.response_representation = Google::Apis::ContentV2_1::OrderreturnsListResponse::Representation command.response_class = Google::Apis::ContentV2_1::OrderreturnsListResponse command.params['merchantId'] = merchant_id unless merchant_id.nil? + command.query['acknowledged'] = acknowledged unless acknowledged.nil? command.query['createdEndDate'] = created_end_date unless created_end_date.nil? command.query['createdStartDate'] = created_start_date unless created_start_date.nil? + command.query['googleOrderIds'] = google_order_ids unless google_order_ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['shipmentStates'] = shipment_states unless shipment_states.nil? + command.query['shipmentStatus'] = shipment_status unless shipment_status.nil? + command.query['shipmentTrackingNumbers'] = shipment_tracking_numbers unless shipment_tracking_numbers.nil? + command.query['shipmentTypes'] = shipment_types unless shipment_types.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Processes return in your Merchant Center account. + # @param [Fixnum] merchant_id + # The ID of the account that manages the order. This cannot be a multi-client + # account. + # @param [String] return_id + # The ID of the return. + # @param [Google::Apis::ContentV2_1::OrderreturnsProcessRequest] orderreturns_process_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ContentV2_1::OrderreturnsProcessResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ContentV2_1::OrderreturnsProcessResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def process_orderreturn(merchant_id, return_id, orderreturns_process_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{merchantId}/orderreturns/{returnId}/process', options) + command.request_representation = Google::Apis::ContentV2_1::OrderreturnsProcessRequest::Representation + command.request_object = orderreturns_process_request_object + command.response_representation = Google::Apis::ContentV2_1::OrderreturnsProcessResponse::Representation + command.response_class = Google::Apis::ContentV2_1::OrderreturnsProcessResponse + command.params['merchantId'] = merchant_id unless merchant_id.nil? + command.params['returnId'] = return_id unless return_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -1879,8 +1998,8 @@ module Google execute_or_queue_command(command, &block) end - # Sandbox only. Moves a test order from state "inProgress" to state " - # pendingShipment". + # Sandbox only. Moves a test order from state "`inProgress`" to state "` + # pendingShipment`". # @param [Fixnum] merchant_id # The ID of the account that manages the order. This cannot be a multi-client # account. @@ -2196,7 +2315,7 @@ module Google # @param [String] template_name # The name of the template to retrieve. # @param [String] country - # The country of the template to retrieve. Defaults to US. + # The country of the template to retrieve. Defaults to `US`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2285,8 +2404,8 @@ module Google # Obtains orders that match the acknowledgement status. When set to true, # obtains orders that have been acknowledged. When false, obtains orders that # have not been acknowledged. - # We recommend using this filter set to false, in conjunction with the - # acknowledge call, such that only un-acknowledged orders are returned. + # We recommend using this filter set to `false`, in conjunction with the ` + # acknowledge` call, such that only un-acknowledged orders are returned. # @param [Fixnum] max_results # The maximum number of orders to return in the response, used for paging. The # default value is 25 orders per page, and the maximum allowed value is 250 @@ -2303,10 +2422,10 @@ module Google # @param [String] placed_date_start # Obtains orders placed after this date (inclusively), in ISO 8601 format. # @param [Array, String] statuses - # Obtains orders that match any of the specified statuses. Please note that - # active is a shortcut for pendingShipment and partiallyShipped, and completed - # is a shortcut for shipped, partiallyDelivered, delivered, partiallyReturned, - # returned, and canceled. + # Obtains orders that match any of the specified statuses. Please note that ` + # active` is a shortcut for `pendingShipment` and `partiallyShipped`, and ` + # completed` is a shortcut for `shipped`, `partiallyDelivered`, `delivered`, ` + # partiallyReturned`, `returned`, and `canceled`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3702,6 +3821,139 @@ module Google execute_or_queue_command(command, &block) end + # Retrieves a settlement report from your Merchant Center account. + # @param [Fixnum] merchant_id + # The Merchant Center account of the settlement report. + # @param [String] settlement_id + # The Google-provided ID of the settlement. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ContentV2_1::SettlementReport] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ContentV2_1::SettlementReport] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_settlementreport(merchant_id, settlement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{merchantId}/settlementreports/{settlementId}', options) + command.response_representation = Google::Apis::ContentV2_1::SettlementReport::Representation + command.response_class = Google::Apis::ContentV2_1::SettlementReport + command.params['merchantId'] = merchant_id unless merchant_id.nil? + command.params['settlementId'] = settlement_id unless settlement_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of settlement reports from your Merchant Center account. + # @param [Fixnum] merchant_id + # The Merchant Center account to list settlements for. + # @param [Fixnum] max_results + # The maximum number of settlements to return in the response, used for paging. + # The default value is 200 returns per page, and the maximum allowed value is + # 5000 returns per page. + # @param [String] page_token + # The token returned by the previous request. + # @param [String] transfer_end_date + # Obtains settlements which have transactions before this date (inclusively), in + # ISO 8601 format. + # @param [String] transfer_start_date + # Obtains settlements which have transactions after this date (inclusively), in + # ISO 8601 format. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ContentV2_1::SettlementreportsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ContentV2_1::SettlementreportsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_settlementreports(merchant_id, max_results: nil, page_token: nil, transfer_end_date: nil, transfer_start_date: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{merchantId}/settlementreports', options) + command.response_representation = Google::Apis::ContentV2_1::SettlementreportsListResponse::Representation + command.response_class = Google::Apis::ContentV2_1::SettlementreportsListResponse + command.params['merchantId'] = merchant_id unless merchant_id.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['transferEndDate'] = transfer_end_date unless transfer_end_date.nil? + command.query['transferStartDate'] = transfer_start_date unless transfer_start_date.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of transactions for the settlement. + # @param [Fixnum] merchant_id + # The Merchant Center account to list transactions for. + # @param [String] settlement_id + # The Google-provided ID of the settlement. + # @param [Fixnum] max_results + # The maximum number of transactions to return in the response, used for paging. + # The default value is 200 transactions per page, and the maximum allowed value + # is 5000 transactions per page. + # @param [String] page_token + # The token returned by the previous request. + # @param [Array, String] transaction_ids + # The list of transactions to return. If not set, all transactions will be + # returned. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ContentV2_1::SettlementtransactionsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ContentV2_1::SettlementtransactionsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_settlementtransactions(merchant_id, settlement_id, max_results: nil, page_token: nil, transaction_ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{merchantId}/settlementreports/{settlementId}/transactions', options) + command.response_representation = Google::Apis::ContentV2_1::SettlementtransactionsListResponse::Representation + command.response_class = Google::Apis::ContentV2_1::SettlementtransactionsListResponse + command.params['merchantId'] = merchant_id unless merchant_id.nil? + command.params['settlementId'] = settlement_id unless settlement_id.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['transactionIds'] = transaction_ids unless transaction_ids.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Retrieves and updates the shipping settings of multiple accounts in a single # request. # @param [Google::Apis::ContentV2_1::ShippingsettingsCustomBatchRequest] shippingsettings_custom_batch_request_object @@ -3739,8 +3991,8 @@ module Google # Retrieves the shipping settings of the account. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which to get/update shipping settings. # @param [String] fields @@ -3917,8 +4169,8 @@ module Google # Updates the shipping settings of the account. # @param [Fixnum] merchant_id # The ID of the managing account. If this parameter is not the same as accountId, - # then this account must be a multi-client account and accountId must be the ID - # of a sub-account of this account. + # then this account must be a multi-client account and `accountId` must be the + # ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which to get/update shipping settings. # @param [Google::Apis::ContentV2_1::ShippingSettings] shipping_settings_object diff --git a/generated/google/apis/customsearch_v1.rb b/generated/google/apis/customsearch_v1.rb index 7c624b7ea..c803a750b 100644 --- a/generated/google/apis/customsearch_v1.rb +++ b/generated/google/apis/customsearch_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/custom-search/v1/introduction module CustomsearchV1 VERSION = 'V1' - REVISION = '20200408' + REVISION = '20200504' end end end diff --git a/generated/google/apis/datacatalog_v1beta1.rb b/generated/google/apis/datacatalog_v1beta1.rb index 76697efcf..2ea8b2b98 100644 --- a/generated/google/apis/datacatalog_v1beta1.rb +++ b/generated/google/apis/datacatalog_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/data-catalog/docs/ module DatacatalogV1beta1 VERSION = 'V1beta1' - REVISION = '20200402' + REVISION = '20200430' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/datacatalog_v1beta1/classes.rb b/generated/google/apis/datacatalog_v1beta1/classes.rb index 4837ae11b..ee2a592e2 100644 --- a/generated/google/apis/datacatalog_v1beta1/classes.rb +++ b/generated/google/apis/datacatalog_v1beta1/classes.rb @@ -1028,7 +1028,8 @@ module Google # * description:y # Note: Query tokens need to have a minimum of 3 characters for substring # matching to work correctly. See [Data Catalog Search - # Syntax](/data-catalog/docs/how-to/search-reference) for more information. + # Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference) + # for more information. # Corresponds to the JSON property `query` # @return [String] attr_accessor :query @@ -1079,6 +1080,44 @@ module Google # @return [Array] attr_accessor :include_project_ids + # Optional. The list of locations to search within. + # 1. If empty, search will be performed in all locations; + # 2. If any of the locations are NOT in the valid locations list, error + # will be returned; + # 3. Otherwise, search only the given locations for matching results. + # Typical usage is to leave this field empty. When a location is + # unreachable as returned in the `SearchCatalogResponse.unreachable` field, + # users can repeat the search request with this parameter set to get + # additional information on the error. + # Valid locations: + # * asia-east1 + # * asia-east2 + # * asia-northeast1 + # * asia-northeast2 + # * asia-northeast3 + # * asia-south1 + # * asia-southeast1 + # * australia-southeast1 + # * eu + # * europe-north1 + # * europe-west1 + # * europe-west2 + # * europe-west3 + # * europe-west4 + # * europe-west6 + # * global + # * northamerica-northeast1 + # * southamerica-east1 + # * us + # * us-central1 + # * us-east1 + # * us-east4 + # * us-west1 + # * us-west2 + # Corresponds to the JSON property `restrictedLocations` + # @return [Array] + attr_accessor :restricted_locations + def initialize(**args) update!(**args) end @@ -1088,6 +1127,7 @@ module Google @include_gcp_public_datasets = args[:include_gcp_public_datasets] if args.key?(:include_gcp_public_datasets) @include_org_ids = args[:include_org_ids] if args.key?(:include_org_ids) @include_project_ids = args[:include_project_ids] if args.key?(:include_project_ids) + @restricted_locations = args[:restricted_locations] if args.key?(:restricted_locations) end end @@ -1106,6 +1146,14 @@ module Google # @return [Array] attr_accessor :results + # Unreachable locations. Search result does not include data from those + # locations. Users can get additional information on the error by repeating + # the search request with a more restrictive parameter -- setting the value + # for `SearchDataCatalogRequest.scope.include_locations`. + # Corresponds to the JSON property `unreachable` + # @return [Array] + attr_accessor :unreachable + def initialize(**args) update!(**args) end @@ -1114,6 +1162,7 @@ module Google def update!(**args) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @results = args[:results] if args.key?(:results) + @unreachable = args[:unreachable] if args.key?(:unreachable) end end @@ -1188,6 +1237,12 @@ module Google # @return [String] attr_accessor :display_name + # Resource name of the policy tag. + # This field will be ignored when calling ImportTaxonomies. + # Corresponds to the JSON property `policyTag` + # @return [String] + attr_accessor :policy_tag + def initialize(**args) update!(**args) end @@ -1197,6 +1252,7 @@ module Google @child_policy_tags = args[:child_policy_tags] if args.key?(:child_policy_tags) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) + @policy_tag = args[:policy_tag] if args.key?(:policy_tag) end end @@ -1293,8 +1349,9 @@ module Google # Tags are used to attach custom metadata to Data Catalog resources. Tags # conform to the specifications within their tag template. - # See [Data Catalog IAM](/data-catalog/docs/concepts/iam) for information on - # the permissions needed to create or view tags. + # See [Data Catalog + # IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information + # on the permissions needed to create or view tags. class GoogleCloudDatacatalogV1beta1Tag include Google::Apis::Core::Hashable @@ -1433,10 +1490,13 @@ module Google # A tag template defines a tag, which can have one or more typed fields. # The template is used to create and attach the tag to GCP resources. - # [Tag template roles](/iam/docs/understanding-roles#data-catalog-roles) - # provide permissions to create, edit, and use the template (see, for example, - # the [TagTemplate User](/data-catalog/docs/how-to/template-user) role, which - # includes permission to use the tag template to tag resources. + # [Tag template + # roles](https://cloud.google.com/iam/docs/understanding-roles#data-catalog- + # roles) + # provide permissions to create, edit, and use the template. See, for example, + # the [TagTemplate + # User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role, + # which includes permission to use the tag template to tag resources. class GoogleCloudDatacatalogV1beta1TagTemplate include Google::Apis::Core::Hashable diff --git a/generated/google/apis/datacatalog_v1beta1/representations.rb b/generated/google/apis/datacatalog_v1beta1/representations.rb index a772db644..6599983f4 100644 --- a/generated/google/apis/datacatalog_v1beta1/representations.rb +++ b/generated/google/apis/datacatalog_v1beta1/representations.rb @@ -570,6 +570,7 @@ module Google property :include_gcp_public_datasets, as: 'includeGcpPublicDatasets' collection :include_org_ids, as: 'includeOrgIds' collection :include_project_ids, as: 'includeProjectIds' + collection :restricted_locations, as: 'restrictedLocations' end end @@ -579,6 +580,7 @@ module Google property :next_page_token, as: 'nextPageToken' collection :results, as: 'results', class: Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1SearchCatalogResult, decorator: Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1SearchCatalogResult::Representation + collection :unreachable, as: 'unreachable' end end @@ -599,6 +601,7 @@ module Google property :description, as: 'description' property :display_name, as: 'displayName' + property :policy_tag, as: 'policyTag' end end diff --git a/generated/google/apis/datacatalog_v1beta1/service.rb b/generated/google/apis/datacatalog_v1beta1/service.rb index 82fb9c6bc..4001b29d3 100644 --- a/generated/google/apis/datacatalog_v1beta1/service.rb +++ b/generated/google/apis/datacatalog_v1beta1/service.rb @@ -59,7 +59,8 @@ module Google # result pages. Also note that results returned (and not returned) can vary # across repeated search queries. # See [Data Catalog Search - # Syntax](/data-catalog/docs/how-to/search-reference) for more information. + # Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference) + # for more information. # @param [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1SearchCatalogRequest] google_cloud_datacatalog_v1beta1_search_catalog_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -104,7 +105,7 @@ module Google # @param [String] sql_resource # The SQL name of the entry. SQL names are case-sensitive. # Examples: - # * `cloud_pubsub.project_id.topic_id` + # * `pubsub.project_id.topic_id` # * ``pubsub.project_id.`topic.id.with.dots` `` # * `bigquery.table.project_id.dataset_id.table_id` # * `bigquery.dataset.project_id.dataset_id` @@ -143,7 +144,8 @@ module Google # locations. # Users should enable the Data Catalog API in the project identified by # the `parent` parameter (see [Data Catalog Resource Project] - # (/data-catalog/docs/concepts/resource-project) for more information). + # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for + # more information). # @param [String] parent # Required. The name of the project this entry group is in. Example: # * projects/`project_id`/locations/`location` @@ -187,7 +189,8 @@ module Google # Deletes an EntryGroup. Only entry groups that do not contain entries can be # deleted. Users should enable the Data Catalog API in the project # identified by the `name` parameter (see [Data Catalog Resource Project] - # (/data-catalog/docs/concepts/resource-project) for more information). + # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for + # more information). # @param [String] name # Required. The name of the entry group. For example, # `projects/`project_id`/locations/`location`/entryGroups/`entry_group_id``. @@ -347,8 +350,9 @@ module Google # Updates an EntryGroup. The user should enable the Data Catalog API in the # project identified by the `entry_group.name` parameter (see [Data Catalog - # Resource Project] (/data-catalog/docs/concepts/resource-project) for more - # information). + # Resource Project] + # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for + # more information). # @param [String] name # The resource name of the entry group in URL format. Example: # * projects/`project_id`/locations/`location`/entryGroups/`entry_group_id` @@ -482,7 +486,8 @@ module Google # be created. # Users should enable the Data Catalog API in the project identified by # the `parent` parameter (see [Data Catalog Resource Project] - # (/data-catalog/docs/concepts/resource-project) for more information). + # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for + # more information). # A maximum of 100,000 entries may be created per entry group. # @param [String] parent # Required. The name of the entry group this entry is in. Example: @@ -527,7 +532,8 @@ module Google # method can be deleted. # Users should enable the Data Catalog API in the project identified by # the `name` parameter (see [Data Catalog Resource Project] - # (/data-catalog/docs/concepts/resource-project) for more information). + # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for + # more information). # @param [String] name # Required. The name of the entry. Example: # * projects/`project_id`/locations/`location`/entryGroups/`entry_group_id`/ @@ -687,7 +693,8 @@ module Google # Updates an existing entry. # Users should enable the Data Catalog API in the project identified by # the `entry.name` parameter (see [Data Catalog Resource Project] - # (/data-catalog/docs/concepts/resource-project) for more information). + # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for + # more information). # @param [String] name # The Data Catalog resource name of the entry in URL format. Example: # * projects/`project_id`/locations/`location`/entryGroups/`entry_group_id`/ @@ -791,12 +798,12 @@ module Google # Creates a tag on an Entry. # Note: The project identified by the `parent` parameter for the - # [tag](/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups. - # entries.tags/create#path-parameters) + # [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/ + # projects.locations.entryGroups.entries.tags/create#path-parameters) # and the # [tag - # template](/data-catalog/docs/reference/rest/v1beta1/projects.locations. - # tagTemplates/create#path-parameters) + # template](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/ + # projects.locations.tagTemplates/create#path-parameters) # used to create the tag must be from the same organization. # @param [String] parent # Required. The name of the resource to attach this tag to. Tags can be attached @@ -955,12 +962,12 @@ module Google # Creates a tag on an Entry. # Note: The project identified by the `parent` parameter for the - # [tag](/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups. - # entries.tags/create#path-parameters) + # [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/ + # projects.locations.entryGroups.entries.tags/create#path-parameters) # and the # [tag - # template](/data-catalog/docs/reference/rest/v1beta1/projects.locations. - # tagTemplates/create#path-parameters) + # template](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/ + # projects.locations.tagTemplates/create#path-parameters) # used to create the tag must be from the same organization. # @param [String] parent # Required. The name of the resource to attach this tag to. Tags can be attached @@ -1119,12 +1126,12 @@ module Google # Creates a tag template. The user should enable the Data Catalog API in # the project identified by the `parent` parameter (see [Data Catalog - # Resource Project](/data-catalog/docs/concepts/resource-project) for more - # information). + # Resource + # Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) + # for more information). # @param [String] parent # Required. The name of the project and the template location - # [region](/compute/docs/regions-zones/#available). - # NOTE: Currently, only the `us-central1 region` is supported. + # [region](https://cloud.google.com/data-catalog/docs/concepts/regions. # Example: # * projects/`project_id`/locations/us-central1 # @param [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1TagTemplate] google_cloud_datacatalog_v1beta1_tag_template_object @@ -1163,7 +1170,8 @@ module Google # Deletes a tag template and all tags using the template. # Users should enable the Data Catalog API in the project identified by # the `name` parameter (see [Data Catalog Resource Project] - # (/data-catalog/docs/concepts/resource-project) for more information). + # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for + # more information). # @param [String] name # Required. The name of the tag template to delete. Example: # * projects/`project_id`/locations/`location`/tagTemplates/`tag_template_id` @@ -1282,7 +1290,8 @@ module Google # and should be updated using their own create/update/delete methods. # Users should enable the Data Catalog API in the project identified by # the `tag_template.name` parameter (see [Data Catalog Resource Project] - # (/data-catalog/docs/concepts/resource-project) for more information). + # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for + # more information). # @param [String] name # The resource name of the tag template in URL format. Example: # * projects/`project_id`/locations/`location`/tagTemplates/`tag_template_id` @@ -1417,12 +1426,11 @@ module Google # Creates a field in a tag template. The user should enable the Data Catalog # API in the project identified by the `parent` parameter (see # [Data Catalog Resource - # Project](/data-catalog/docs/concepts/resource-project) for more - # information). + # Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) + # for more information). # @param [String] parent # Required. The name of the project and the template location - # [region](/compute/docs/regions-zones/#available). - # NOTE: Currently, only the `us-central1 region` is supported. + # [region](https://cloud.google.com/data-catalog/docs/concepts/regions). # Example: # * projects/`project_id`/locations/us-central1/tagTemplates/`tag_template_id` # @param [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1TagTemplateField] google_cloud_datacatalog_v1beta1_tag_template_field_object @@ -1465,7 +1473,8 @@ module Google # Deletes a field in a tag template and all uses of that field. # Users should enable the Data Catalog API in the project identified by # the `name` parameter (see [Data Catalog Resource Project] - # (/data-catalog/docs/concepts/resource-project) for more information). + # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for + # more information). # @param [String] name # Required. The name of the tag template field to delete. Example: # * projects/`project_id`/locations/`location`/tagTemplates/`tag_template_id`/ @@ -1505,7 +1514,8 @@ module Google # Updates a field in a tag template. This method cannot be used to update the # field type. Users should enable the Data Catalog API in the project # identified by the `name` parameter (see [Data Catalog Resource Project] - # (/data-catalog/docs/concepts/resource-project) for more information). + # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for + # more information). # @param [String] name # Required. The name of the tag template field. Example: # * projects/`project_id`/locations/`location`/tagTemplates/`tag_template_id`/ @@ -1555,8 +1565,9 @@ module Google # Renames a field in a tag template. The user should enable the Data Catalog # API in the project identified by the `name` parameter (see [Data Catalog - # Resource Project](/data-catalog/docs/concepts/resource-project) for more - # information). + # Resource + # Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) + # for more information). # @param [String] name # Required. The name of the tag template. Example: # * projects/`project_id`/locations/`location`/tagTemplates/`tag_template_id`/ @@ -1764,8 +1775,7 @@ module Google # This method provides a bulk taxonomy / policy tag creation using nested # proto structure. # @param [String] parent - # Required. Resource name of project that the newly created taxonomies will - # belong to. + # Required. Resource name of project that the imported taxonomies will belong to. # @param [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1ImportTaxonomiesRequest] google_cloud_datacatalog_v1beta1_import_taxonomies_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/dataproc_v1.rb b/generated/google/apis/dataproc_v1.rb index 07d64ee3d..9c3f4d763 100644 --- a/generated/google/apis/dataproc_v1.rb +++ b/generated/google/apis/dataproc_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/dataproc/ module DataprocV1 VERSION = 'V1' - REVISION = '20200407' + REVISION = '20200501' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dataproc_v1/classes.rb b/generated/google/apis/dataproc_v1/classes.rb index 74ab37bde..74454d3ba 100644 --- a/generated/google/apis/dataproc_v1/classes.rb +++ b/generated/google/apis/dataproc_v1/classes.rb @@ -23,7 +23,8 @@ module Google module DataprocV1 # Specifies the type and number of accelerator cards attached to the instances - # of an instance. See GPUs on Compute Engine. + # of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/ + # docs/gpus/). class AcceleratorConfig include Google::Apis::Core::Hashable @@ -33,13 +34,15 @@ module Google attr_accessor :accelerator_count # Full URL, partial URI, or short name of the accelerator type resource to - # expose to this instance. See Compute Engine AcceleratorTypes.Examples: + # expose to this instance. See Compute Engine AcceleratorTypes (https://cloud. + # google.com/compute/docs/reference/beta/acceleratorTypes).Examples: # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/ # acceleratorTypes/nvidia-tesla-k80 # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 # nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone - # Placement feature, you must use the short name of the accelerator type - # resource, for example, nvidia-tesla-k80. + # Placement (https://cloud.google.com/dataproc/docs/concepts/configuring- + # clusters/auto-zone#using_auto_zone_placement) feature, you must use the short + # name of the accelerator type resource, for example, nvidia-tesla-k80. # Corresponds to the JSON property `acceleratorTypeUri` # @return [String] attr_accessor :accelerator_type_uri @@ -400,7 +403,8 @@ module Google # Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your # cluster's staging bucket according to the Compute Engine zone where your # cluster is deployed, and then create and manage this project-level, per- - # location bucket (see Dataproc staging bucket). + # location bucket (see Dataproc staging bucket (https://cloud.google.com/ + # dataproc/docs/concepts/configuring-clusters/staging-bucket)). # Corresponds to the JSON property `configBucket` # @return [String] attr_accessor :config_bucket @@ -902,8 +906,9 @@ module Google # Optional. The Compute Engine network to be used for machine communications. # Cannot be specified with subnetwork_uri. If neither network_uri nor # subnetwork_uri is specified, the "default" network of the project is used, if - # it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks for more - # information).A full URL, partial URI, or short name are valid. Examples: + # it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks (https:// + # cloud.google.com/compute/docs/subnetworks) for more information).A full URL, + # partial URI, or short name are valid. Examples: # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/ # default # projects/[project_id]/regions/global/default @@ -917,9 +922,14 @@ module Google # @return [Google::Apis::DataprocV1::ReservationAffinity] attr_accessor :reservation_affinity - # Optional. The Dataproc service account (also see VM Data Plane identity) used - # by Dataproc cluster VM instances to access Google Cloud Platform services.If - # not specified, the Compute Engine default service account is used. + # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/ + # concepts/configuring-clusters/service-accounts# + # service_accounts_in_cloud_dataproc) (also see VM Data Plane identity (https:// + # cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals# + # vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances + # to access Google Cloud Platform services.If not specified, the Compute Engine + # default service account (https://cloud.google.com/compute/docs/access/service- + # accounts#default_service_account) is used. # Corresponds to the JSON property `serviceAccount` # @return [String] attr_accessor :service_account @@ -949,7 +959,8 @@ module Google # @return [String] attr_accessor :subnetwork_uri - # The Compute Engine tags to add to all instances (see Tagging instances). + # The Compute Engine tags to add to all instances (see Tagging instances (https:/ + # /cloud.google.com/compute/docs/label-or-tag-resources#tags)). # Corresponds to the JSON property `tags` # @return [Array] attr_accessor :tags @@ -1010,7 +1021,9 @@ module Google # Optional. The policy format version to be returned.Valid values are 0, 1, and # 3. Requests specifying an invalid value will be rejected.Requests for policies # with any conditional bindings must specify version 3. Policies without any - # conditional bindings may specify any valid value or leave the field unset. + # conditional bindings may specify any valid value 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 `requestedPolicyVersion` # @return [Fixnum] attr_accessor :requested_policy_version @@ -1261,8 +1274,9 @@ module Google # machineTypes/n1-standard-2 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone - # Placement feature, you must use the short name of the machine type resource, - # for example, n1-standard-2. + # Placement (https://cloud.google.com/dataproc/docs/concepts/configuring- + # clusters/auto-zone#using_auto_zone_placement) feature, you must use the short + # name of the machine type resource, for example, n1-standard-2. # Corresponds to the JSON property `machineTypeUri` # @return [String] attr_accessor :machine_type_uri @@ -1273,7 +1287,8 @@ module Google attr_accessor :managed_group_config # Optional. Specifies the minimum cpu platform for the Instance Group. See - # Dataproc→Minimum CPU Platform. + # Dataproc -> Minimum CPU Platform (https://cloud.google.com/dataproc/docs/ + # concepts/compute/dataproc-min-cpu). # Corresponds to the JSON property `minCpuPlatform` # @return [String] attr_accessor :min_cpu_platform @@ -1417,8 +1432,9 @@ module Google attr_accessor :placement # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: - # The Dataproc Presto Optional Component must be enabled when the cluster is - # created to submit a Presto job to the cluster. + # The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/ + # concepts/components/presto) must be enabled when the cluster is created to + # submit a Presto job to the cluster. # Corresponds to the JSON property `prestoJob` # @return [Google::Apis::DataprocV1::PrestoJob] attr_accessor :presto_job @@ -2173,8 +2189,9 @@ module Google attr_accessor :prerequisite_step_ids # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: - # The Dataproc Presto Optional Component must be enabled when the cluster is - # created to submit a Presto job to the cluster. + # The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/ + # concepts/components/presto) must be enabled when the cluster is created to + # submit a Presto job to the cluster. # Corresponds to the JSON property `prestoJob` # @return [Google::Apis::DataprocV1::PrestoJob] attr_accessor :presto_job @@ -2333,10 +2350,13 @@ module Google # 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.Optionally, a binding can 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.JSON example: + # 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": [ # ` @@ -2350,7 +2370,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -2418,7 +2440,9 @@ module Google # 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. + # 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 @@ -2436,8 +2460,9 @@ module Google end # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: - # The Dataproc Presto Optional Component must be enabled when the cluster is - # created to submit a Presto job to the cluster. + # The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/ + # concepts/components/presto) must be enabled when the cluster is created to + # submit a Presto job to the cluster. class PrestoJob include Google::Apis::Core::Hashable @@ -2681,10 +2706,13 @@ module Google # 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.Optionally, a binding can 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.JSON example: + # 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": [ # ` @@ -2698,7 +2726,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -2747,9 +2777,11 @@ module Google include Google::Apis::Core::Hashable # Optional. The version of software inside the cluster. It must be one of the - # supported Dataproc Versions, such as "1.2" (including a subminor version, such - # as "1.2.29"), or the "preview" version. If unspecified, it defaults to the - # latest Debian version. + # supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/ + # versioning/dataproc-versions#supported_cloud_dataproc_versions), such as "1.2" + # (including a subminor version, such as "1.2.29"), or the "preview" version ( + # https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions# + # other_versions). If unspecified, it defaults to the latest Debian version. # Corresponds to the JSON property `imageVersion` # @return [String] attr_accessor :image_version @@ -2770,7 +2802,8 @@ module Google # mapred: mapred-site.xml # pig: pig.properties # spark: spark-defaults.conf - # yarn: yarn-site.xmlFor more information, see Cluster properties. + # yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud. + # google.com/dataproc/docs/concepts/cluster-properties). # Corresponds to the JSON property `properties` # @return [Hash] attr_accessor :properties diff --git a/generated/google/apis/dataproc_v1/service.rb b/generated/google/apis/dataproc_v1/service.rb index 1c25cf881..12205d00f 100644 --- a/generated/google/apis/dataproc_v1/service.rb +++ b/generated/google/apis/dataproc_v1/service.rb @@ -239,8 +239,8 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy.Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and - # PERMISSION_DENIED + # existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED + # errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. See the # operation documentation for the appropriate value for this field. @@ -659,8 +659,8 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy.Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and - # PERMISSION_DENIED + # existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED + # errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. See the # operation documentation for the appropriate value for this field. @@ -965,8 +965,8 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy.Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and - # PERMISSION_DENIED + # existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED + # errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. See the # operation documentation for the appropriate value for this field. @@ -1442,8 +1442,8 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy.Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and - # PERMISSION_DENIED + # existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED + # errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. See the # operation documentation for the appropriate value for this field. @@ -1770,8 +1770,8 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy.Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and - # PERMISSION_DENIED + # existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED + # errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. See the # operation documentation for the appropriate value for this field. @@ -2098,8 +2098,8 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy.Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and - # PERMISSION_DENIED + # existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED + # errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. See the # operation documentation for the appropriate value for this field. @@ -2477,8 +2477,8 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy.Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and - # PERMISSION_DENIED + # existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED + # errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. See the # operation documentation for the appropriate value for this field. diff --git a/generated/google/apis/dataproc_v1beta2.rb b/generated/google/apis/dataproc_v1beta2.rb index bbd56a654..c90c273e6 100644 --- a/generated/google/apis/dataproc_v1beta2.rb +++ b/generated/google/apis/dataproc_v1beta2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/dataproc/ module DataprocV1beta2 VERSION = 'V1beta2' - REVISION = '20200407' + REVISION = '20200409' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dataproc_v1beta2/classes.rb b/generated/google/apis/dataproc_v1beta2/classes.rb index 0a3540299..fab35fdc9 100644 --- a/generated/google/apis/dataproc_v1beta2/classes.rb +++ b/generated/google/apis/dataproc_v1beta2/classes.rb @@ -23,7 +23,8 @@ module Google module DataprocV1beta2 # Specifies the type and number of accelerator cards attached to the instances - # of an instance group (see GPUs on Compute Engine). + # of an instance group (see GPUs on Compute Engine (https://cloud.google.com/ + # compute/docs/gpus/)). class AcceleratorConfig include Google::Apis::Core::Hashable @@ -33,12 +34,15 @@ module Google attr_accessor :accelerator_count # Full URL, partial URI, or short name of the accelerator type resource to - # expose to this instance. See Compute Engine AcceleratorTypesExamples * https:// - # www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/ + # expose to this instance. See Compute Engine AcceleratorTypes (https://cloud. + # google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www. + # googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/ # acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/ # acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If - # you are using the Dataproc Auto Zone Placement feature, you must use the short - # name of the accelerator type resource, for example, nvidia-tesla-k80. + # you are using the Dataproc Auto Zone Placement (https://cloud.google.com/ + # dataproc/docs/concepts/configuring-clusters/auto-zone# + # using_auto_zone_placement) feature, you must use the short name of the + # accelerator type resource, for example, nvidia-tesla-k80. # Corresponds to the JSON property `acceleratorTypeUri` # @return [String] attr_accessor :accelerator_type_uri @@ -399,7 +403,8 @@ module Google # Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your # cluster's staging bucket according to the Compute Engine zone where your # cluster is deployed, and then create and manage this project-level, per- - # location bucket (see Dataproc staging bucket). + # location bucket (see Dataproc staging bucket (https://cloud.google.com/ + # dataproc/docs/concepts/configuring-clusters/staging-bucket)). # Corresponds to the JSON property `configBucket` # @return [String] attr_accessor :config_bucket @@ -941,8 +946,9 @@ module Google # Optional. The Compute Engine network to be used for machine communications. # Cannot be specified with subnetwork_uri. If neither network_uri nor # subnetwork_uri is specified, the "default" network of the project is used, if - # it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks for more - # information).A full URL, partial URI, or short name are valid. Examples: + # it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks (https:// + # cloud.google.com/compute/docs/subnetworks) for more information).A full URL, + # partial URI, or short name are valid. Examples: # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/ # default # projects/[project_id]/regions/global/default @@ -956,9 +962,14 @@ module Google # @return [Google::Apis::DataprocV1beta2::ReservationAffinity] attr_accessor :reservation_affinity - # Optional. The Dataproc service account (also see VM Data Plane identity) used - # by Dataproc cluster VM instances to access Google Cloud Platform services.If - # not specified, the Compute Engine default service account is used. + # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/ + # concepts/configuring-clusters/service-accounts# + # service_accounts_in_cloud_dataproc) (also see VM Data Plane identity (https:// + # cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals# + # vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances + # to access Google Cloud Platform services.If not specified, the Compute Engine + # default service account (https://cloud.google.com/compute/docs/access/service- + # accounts#default_service_account) is used. # Corresponds to the JSON property `serviceAccount` # @return [String] attr_accessor :service_account @@ -988,7 +999,8 @@ module Google # @return [String] attr_accessor :subnetwork_uri - # The Compute Engine tags to add to all instances (see Tagging instances). + # The Compute Engine tags to add to all instances (see Tagging instances (https:/ + # /cloud.google.com/compute/docs/label-or-tag-resources#tags)). # Corresponds to the JSON property `tags` # @return [Array] attr_accessor :tags @@ -1319,8 +1331,9 @@ module Google # machineTypes/n1-standard-2 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone - # Placement feature, you must use the short name of the machine type resource, - # for example, n1-standard-2. + # Placement (https://cloud.google.com/dataproc/docs/concepts/configuring- + # clusters/auto-zone#using_auto_zone_placement) feature, you must use the short + # name of the machine type resource, for example, n1-standard-2. # Corresponds to the JSON property `machineTypeUri` # @return [String] attr_accessor :machine_type_uri @@ -1330,8 +1343,9 @@ module Google # @return [Google::Apis::DataprocV1beta2::ManagedGroupConfig] attr_accessor :managed_group_config - # Specifies the minimum cpu platform for the Instance Group. See Dataproc→ - # Minimum CPU Platform. + # Specifies the minimum cpu platform for the Instance Group. See Dataproc -> + # Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/ + # dataproc-min-cpu). # Corresponds to the JSON property `minCpuPlatform` # @return [String] attr_accessor :min_cpu_platform @@ -1481,8 +1495,9 @@ module Google attr_accessor :placement # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: - # The Dataproc Presto Optional Component must be enabled when the cluster is - # created to submit a Presto job to the cluster. + # The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/ + # concepts/components/presto) must be enabled when the cluster is created to + # submit a Presto job to the cluster. # Corresponds to the JSON property `prestoJob` # @return [Google::Apis::DataprocV1beta2::PrestoJob] attr_accessor :presto_job @@ -2273,8 +2288,9 @@ module Google attr_accessor :prerequisite_step_ids # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: - # The Dataproc Presto Optional Component must be enabled when the cluster is - # created to submit a Presto job to the cluster. + # The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/ + # concepts/components/presto) must be enabled when the cluster is created to + # submit a Presto job to the cluster. # Corresponds to the JSON property `prestoJob` # @return [Google::Apis::DataprocV1beta2::PrestoJob] attr_accessor :presto_job @@ -2539,8 +2555,9 @@ module Google end # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: - # The Dataproc Presto Optional Component must be enabled when the cluster is - # created to submit a Presto job to the cluster. + # The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/ + # concepts/components/presto) must be enabled when the cluster is created to + # submit a Presto job to the cluster. class PrestoJob include Google::Apis::Core::Hashable @@ -2850,9 +2867,11 @@ module Google include Google::Apis::Core::Hashable # Optional. The version of software inside the cluster. It must be one of the - # supported Dataproc Versions, such as "1.2" (including a subminor version, such - # as "1.2.29"), or the "preview" version. If unspecified, it defaults to the - # latest Debian version. + # supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/ + # versioning/dataproc-versions#supported_cloud_dataproc_versions), such as "1.2" + # (including a subminor version, such as "1.2.29"), or the "preview" version ( + # https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions# + # other_versions). If unspecified, it defaults to the latest Debian version. # Corresponds to the JSON property `imageVersion` # @return [String] attr_accessor :image_version @@ -2873,7 +2892,8 @@ module Google # mapred: mapred-site.xml # pig: pig.properties # spark: spark-defaults.conf - # yarn: yarn-site.xmlFor more information, see Cluster properties. + # yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud. + # google.com/dataproc/docs/concepts/cluster-properties). # Corresponds to the JSON property `properties` # @return [Hash] attr_accessor :properties diff --git a/generated/google/apis/dialogflow_v2.rb b/generated/google/apis/dialogflow_v2.rb index cd3c1c533..a87ed6909 100644 --- a/generated/google/apis/dialogflow_v2.rb +++ b/generated/google/apis/dialogflow_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/dialogflow/ module DialogflowV2 VERSION = 'V2' - REVISION = '20200408' + REVISION = '20200503' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dialogflow_v2/classes.rb b/generated/google/apis/dialogflow_v2/classes.rb index 03ee8a47f..8be6fe9be 100644 --- a/generated/google/apis/dialogflow_v2/classes.rb +++ b/generated/google/apis/dialogflow_v2/classes.rb @@ -483,7 +483,7 @@ module Google # - MapKey value: parameter name # - MapValue type: # - If parameter's entity type is a composite entity: map - # - Else: string + # - Else: string or number, depending on parameter value type # - MapValue value: # - If parameter's entity type is a composite entity: # map from composite entity property names to property values @@ -773,6 +773,57 @@ module Google end end + # Represents an agent environment. + class GoogleCloudDialogflowV2Environment + include Google::Apis::Core::Hashable + + # Optional. The agent version loaded into this environment. + # Format: `projects//agent/versions/`. + # Corresponds to the JSON property `agentVersion` + # @return [String] + attr_accessor :agent_version + + # Optional. The developer-provided description for this environment. + # The maximum length is 500 characters. If exceeded, the request is rejected. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Output only. The unique identifier of this agent environment. + # Format: `projects//agent/environments/`. + # For Environment ID, "-" is reserved for 'draft' environment. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. The state of this environment. This field is read-only, i.e., it + # cannot be + # set by create and update methods. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # Output only. The last update time of this environment. This field is read-only, + # i.e., it + # cannot be set by create and update methods. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @agent_version = args[:agent_version] if args.key?(:agent_version) + @description = args[:description] if args.key?(:description) + @name = args[:name] if args.key?(:name) + @state = args[:state] if args.key?(:state) + @update_time = args[:update_time] if args.key?(:update_time) + end + end + # Events allow for matching intents by event name instead of the natural # language input. For instance, input `` can trigger a personalized welcome response. @@ -795,6 +846,18 @@ module Google attr_accessor :name # The collection of parameters associated with the event. + # Depending on your protocol or client library language, this is a + # map, associative array, symbol table, dictionary, or JSON object + # composed of a collection of (MapKey, MapValue) pairs: + # - MapKey type: string + # - MapKey value: parameter name + # - MapValue type: + # - If parameter's entity type is a composite entity: map + # - Else: string or number, depending on parameter value type + # - MapValue value: + # - If parameter's entity type is a composite entity: + # map from composite entity property names to property values + # - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters @@ -957,6 +1020,7 @@ module Google attr_accessor :request_headers # Required. The fulfillment URI for receiving POST requests. + # It must use https protocol. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -2447,6 +2511,33 @@ module Google end end + # The response message for Environments.ListEnvironments. + class GoogleCloudDialogflowV2ListEnvironmentsResponse + include Google::Apis::Core::Hashable + + # The list of agent environments. There will be a maximum number of items + # returned based on the page_size field in the request. + # Corresponds to the JSON property `environments` + # @return [Array] + attr_accessor :environments + + # Token to retrieve the next page of results, or empty if there are no + # more results in the list. + # 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) + @environments = args[:environments] if args.key?(:environments) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + # The response message for Intents.ListIntents. class GoogleCloudDialogflowV2ListIntentsResponse include Google::Apis::Core::Hashable @@ -2857,6 +2948,18 @@ module Google attr_accessor :output_contexts # The collection of extracted parameters. + # Depending on your protocol or client library language, this is a + # map, associative array, symbol table, dictionary, or JSON object + # composed of a collection of (MapKey, MapValue) pairs: + # - MapKey type: string + # - MapKey value: parameter name + # - MapValue type: + # - If parameter's entity type is a composite entity: map + # - Else: string or number, depending on parameter value type + # - MapValue value: + # - If parameter's entity type is a composite entity: + # map from composite entity property names to property values + # - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters @@ -3396,29 +3499,33 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EventInput] attr_accessor :followup_event_input - # Optional. The collection of rich messages to present to the user. This - # value is passed directly to `QueryResult.fulfillment_messages`. + # Optional. The rich response messages intended for the end-user. + # When provided, Dialogflow uses this field to populate + # QueryResult.fulfillment_messages sent to the integration or API caller. # Corresponds to the JSON property `fulfillmentMessages` # @return [Array] attr_accessor :fulfillment_messages - # Optional. The text to be shown on the screen. This value is passed directly - # to `QueryResult.fulfillment_text`. + # Optional. The text response message intended for the end-user. + # It is recommended to use `fulfillment_messages.text.text[0]` instead. + # When provided, Dialogflow uses this field to populate + # QueryResult.fulfillment_text sent to the integration or API caller. # Corresponds to the JSON property `fulfillmentText` # @return [String] attr_accessor :fulfillment_text - # Optional. The collection of output contexts. This value is passed directly - # to `QueryResult.output_contexts`. + # Optional. The collection of output contexts that will overwrite currently + # active contexts for the session and reset their lifespans. + # When provided, Dialogflow uses this field to populate + # QueryResult.output_contexts sent to the integration or API caller. # Corresponds to the JSON property `outputContexts` # @return [Array] attr_accessor :output_contexts # Optional. This field can be used to pass custom data from your webhook to the - # API - # caller. Arbitrary JSON objects are supported. + # integration or API caller. Arbitrary JSON objects are supported. # When provided, Dialogflow uses this field to populate - # `QueryResult.webhook_payload` sent to the API caller. + # QueryResult.webhook_payload sent to the integration or API caller. # This field is also used by the # [Google Assistant # integration](https://cloud.google.com/dialogflow/docs/integrations/aog) @@ -3432,14 +3539,17 @@ module Google # Optional. Additional session entity types to replace or extend developer # entity types with. The entity synonyms apply to all languages and persist - # for the session of this query. Setting the session entity types inside - # webhook overwrites the session entity types that have been set through - # `DetectIntentRequest.query_params.session_entity_types`. + # for the session. Setting this data from a webhook overwrites + # the session entity types that have been set using `detectIntent`, + # `streamingDetectIntent` or SessionEntityType management methods. # Corresponds to the JSON property `sessionEntityTypes` # @return [Array] attr_accessor :session_entity_types - # Optional. This value is passed directly to `QueryResult.webhook_source`. + # Optional. A custom field used to identify the webhook source. + # Arbitrary strings are supported. + # When provided, Dialogflow uses this field to populate + # QueryResult.webhook_source sent to the integration or API caller. # Corresponds to the JSON property `source` # @return [String] attr_accessor :source @@ -3602,7 +3712,7 @@ module Google # - MapKey value: parameter name # - MapValue type: # - If parameter's entity type is a composite entity: map - # - Else: string + # - Else: string or number, depending on parameter value type # - MapValue value: # - If parameter's entity type is a composite entity: # map from composite entity property names to property values @@ -3737,6 +3847,18 @@ module Google attr_accessor :name # The collection of parameters associated with the event. + # Depending on your protocol or client library language, this is a + # map, associative array, symbol table, dictionary, or JSON object + # composed of a collection of (MapKey, MapValue) pairs: + # - MapKey type: string + # - MapKey value: parameter name + # - MapValue type: + # - If parameter's entity type is a composite entity: map + # - Else: string or number, depending on parameter value type + # - MapValue value: + # - If parameter's entity type is a composite entity: + # map from composite entity property names to property values + # - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters @@ -3819,7 +3941,7 @@ module Google # @return [Array] attr_accessor :events - # Read-only. Information about all followup intents that have this intent as + # Output only. Information about all followup intents that have this intent as # a direct or indirect parent. We populate this field only in the output. # Corresponds to the JSON property `followupIntentInfo` # @return [Array] @@ -3869,7 +3991,7 @@ module Google attr_accessor :ml_enabled alias_method :ml_enabled?, :ml_enabled - # The unique identifier of this intent. + # Optional. The unique identifier of this intent. # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents # methods. # Format: `projects//agent/intents/`. @@ -3891,7 +4013,7 @@ module Google # @return [Array] attr_accessor :parameters - # Read-only after creation. The unique identifier of the parent intent in the + # Optional. The unique identifier of the parent intent in the # chain of followup intents. You can set this field when creating an intent, # for example with CreateIntent or # BatchUpdateIntents, in order to make this @@ -3902,7 +4024,7 @@ module Google # @return [String] attr_accessor :parent_followup_intent_name - # The priority of this intent. Higher numbers represent higher + # Optional. The priority of this intent. Higher numbers represent higher # priorities. # - If the supplied value is unspecified or 0, the service # translates the value to 500,000, which corresponds to the @@ -3920,9 +4042,9 @@ module Google attr_accessor :reset_contexts alias_method :reset_contexts?, :reset_contexts - # Read-only. The unique identifier of the root intent in the chain of + # Output only. The unique identifier of the root intent in the chain of # followup intents. It identifies the correct followup intents chain for - # this intent. We populate this field only in the output. + # this intent. # Format: `projects//agent/intents/`. # Corresponds to the JSON property `rootFollowupIntentName` # @return [String] @@ -5643,7 +5765,7 @@ module Google class GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata include Google::Apis::Core::Hashable - # Required. The current state of this operation. + # Required. Output only. The current state of this operation. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state @@ -5809,6 +5931,18 @@ module Google attr_accessor :output_contexts # The collection of extracted parameters. + # Depending on your protocol or client library language, this is a + # map, associative array, symbol table, dictionary, or JSON object + # composed of a collection of (MapKey, MapValue) pairs: + # - MapKey type: string + # - MapKey value: parameter name + # - MapValue type: + # - If parameter's entity type is a composite entity: map + # - Else: string or number, depending on parameter value type + # - MapValue value: + # - If parameter's entity type is a composite entity: + # map from composite entity property names to property values + # - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters @@ -6054,29 +6188,33 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1EventInput] attr_accessor :followup_event_input - # Optional. The collection of rich messages to present to the user. This - # value is passed directly to `QueryResult.fulfillment_messages`. + # Optional. The rich response messages intended for the end-user. + # When provided, Dialogflow uses this field to populate + # QueryResult.fulfillment_messages sent to the integration or API caller. # Corresponds to the JSON property `fulfillmentMessages` # @return [Array] attr_accessor :fulfillment_messages - # Optional. The text to be shown on the screen. This value is passed directly - # to `QueryResult.fulfillment_text`. + # Optional. The text response message intended for the end-user. + # It is recommended to use `fulfillment_messages.text.text[0]` instead. + # When provided, Dialogflow uses this field to populate + # QueryResult.fulfillment_text sent to the integration or API caller. # Corresponds to the JSON property `fulfillmentText` # @return [String] attr_accessor :fulfillment_text - # Optional. The collection of output contexts. This value is passed directly - # to `QueryResult.output_contexts`. + # Optional. The collection of output contexts that will overwrite currently + # active contexts for the session and reset their lifespans. + # When provided, Dialogflow uses this field to populate + # QueryResult.output_contexts sent to the integration or API caller. # Corresponds to the JSON property `outputContexts` # @return [Array] attr_accessor :output_contexts # Optional. This field can be used to pass custom data from your webhook to the - # API - # caller. Arbitrary JSON objects are supported. + # integration or API caller. Arbitrary JSON objects are supported. # When provided, Dialogflow uses this field to populate - # `QueryResult.webhook_payload` sent to the API caller. + # QueryResult.webhook_payload sent to the integration or API caller. # This field is also used by the # [Google Assistant # integration](https://cloud.google.com/dialogflow/docs/integrations/aog) @@ -6090,14 +6228,17 @@ module Google # Optional. Additional session entity types to replace or extend developer # entity types with. The entity synonyms apply to all languages and persist - # for the session of this query. Setting the session entity types inside - # webhook overwrites the session entity types that have been set through - # `DetectIntentRequest.query_params.session_entity_types`. + # for the session. Setting this data from a webhook overwrites + # the session entity types that have been set using `detectIntent`, + # `streamingDetectIntent` or SessionEntityType management methods. # Corresponds to the JSON property `sessionEntityTypes` # @return [Array] attr_accessor :session_entity_types - # Optional. This value is passed directly to `QueryResult.webhook_source`. + # Optional. A custom field used to identify the webhook source. + # Arbitrary strings are supported. + # When provided, Dialogflow uses this field to populate + # QueryResult.webhook_source sent to the integration or API caller. # Corresponds to the JSON property `source` # @return [String] attr_accessor :source @@ -6119,6 +6260,33 @@ module Google end end + # The response message for Agents.ExportAgent. + class GoogleCloudDialogflowV3alpha1ExportAgentResponse + include Google::Apis::Core::Hashable + + # Uncompressed raw byte content for agent. + # Corresponds to the JSON property `agentContent` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :agent_content + + # The URI to a file containing the exported agent. This field is populated + # only if `agent_uri` is specified in ExportAgentRequest. + # Corresponds to the JSON property `agentUri` + # @return [String] + attr_accessor :agent_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @agent_content = args[:agent_content] if args.key?(:agent_content) + @agent_uri = args[:agent_uri] if args.key?(:agent_uri) + end + end + # The response message for Operations.ListOperations. class GoogleLongrunningListOperationsResponse include Google::Apis::Core::Hashable diff --git a/generated/google/apis/dialogflow_v2/representations.rb b/generated/google/apis/dialogflow_v2/representations.rb index d877ddc69..a39a2c3ba 100644 --- a/generated/google/apis/dialogflow_v2/representations.rb +++ b/generated/google/apis/dialogflow_v2/representations.rb @@ -130,6 +130,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDialogflowV2Environment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDialogflowV2EventInput class Representation < Google::Apis::Core::JsonRepresentation; end @@ -394,6 +400,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDialogflowV2ListEnvironmentsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDialogflowV2ListIntentsResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -934,6 +946,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDialogflowV3alpha1ExportAgentResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleLongrunningListOperationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1150,6 +1168,17 @@ module Google end end + class GoogleCloudDialogflowV2Environment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :agent_version, as: 'agentVersion' + property :description, as: 'description' + property :name, as: 'name' + property :state, as: 'state' + property :update_time, as: 'updateTime' + end + end + class GoogleCloudDialogflowV2EventInput # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1614,6 +1643,15 @@ module Google end end + class GoogleCloudDialogflowV2ListEnvironmentsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :environments, as: 'environments', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Environment, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Environment::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + class GoogleCloudDialogflowV2ListIntentsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2566,6 +2604,14 @@ module Google end end + class GoogleCloudDialogflowV3alpha1ExportAgentResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :agent_content, :base64 => true, as: 'agentContent' + property :agent_uri, as: 'agentUri' + end + end + class GoogleLongrunningListOperationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/dialogflow_v2/service.rb b/generated/google/apis/dialogflow_v2/service.rb index b10f29cdc..83a9376da 100644 --- a/generated/google/apis/dialogflow_v2/service.rb +++ b/generated/google/apis/dialogflow_v2/service.rb @@ -826,6 +826,45 @@ module Google execute_or_queue_command(command, &block) end + # Returns the list of all non-draft environments of the specified agent. + # @param [String] parent + # Required. The agent to list all environments from. + # Format: `projects//agent`. + # @param [Fixnum] page_size + # Optional. The maximum number of items to return in a single page. By default + # 100 and + # at most 1000. + # @param [String] page_token + # Optional. The next_page_token value returned from a previous list request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListEnvironmentsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListEnvironmentsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_agent_environments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2/{+parent}/environments', options) + command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListEnvironmentsResponse::Representation + command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListEnvironmentsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Deletes all active contexts in the specified session. # @param [String] parent # Required. The name of the session to delete all contexts from. Format: diff --git a/generated/google/apis/dialogflow_v2beta1.rb b/generated/google/apis/dialogflow_v2beta1.rb index 5c2eae4e7..47d913ba8 100644 --- a/generated/google/apis/dialogflow_v2beta1.rb +++ b/generated/google/apis/dialogflow_v2beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/dialogflow/ module DialogflowV2beta1 VERSION = 'V2beta1' - REVISION = '20200408' + REVISION = '20200503' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dialogflow_v2beta1/classes.rb b/generated/google/apis/dialogflow_v2beta1/classes.rb index a406107c0..8e35b3e68 100644 --- a/generated/google/apis/dialogflow_v2beta1/classes.rb +++ b/generated/google/apis/dialogflow_v2beta1/classes.rb @@ -142,7 +142,7 @@ module Google # - MapKey value: parameter name # - MapValue type: # - If parameter's entity type is a composite entity: map - # - Else: string + # - Else: string or number, depending on parameter value type # - MapValue value: # - If parameter's entity type is a composite entity: # map from composite entity property names to property values @@ -322,6 +322,18 @@ module Google attr_accessor :name # The collection of parameters associated with the event. + # Depending on your protocol or client library language, this is a + # map, associative array, symbol table, dictionary, or JSON object + # composed of a collection of (MapKey, MapValue) pairs: + # - MapKey type: string + # - MapKey value: parameter name + # - MapValue type: + # - If parameter's entity type is a composite entity: map + # - Else: string or number, depending on parameter value type + # - MapValue value: + # - If parameter's entity type is a composite entity: + # map from composite entity property names to property values + # - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters @@ -1829,6 +1841,18 @@ module Google attr_accessor :output_contexts # The collection of extracted parameters. + # Depending on your protocol or client library language, this is a + # map, associative array, symbol table, dictionary, or JSON object + # composed of a collection of (MapKey, MapValue) pairs: + # - MapKey type: string + # - MapKey value: parameter name + # - MapValue type: + # - If parameter's entity type is a composite entity: map + # - Else: string or number, depending on parameter value type + # - MapValue value: + # - If parameter's entity type is a composite entity: + # map from composite entity property names to property values + # - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters @@ -2059,29 +2083,33 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2EventInput] attr_accessor :followup_event_input - # Optional. The collection of rich messages to present to the user. This - # value is passed directly to `QueryResult.fulfillment_messages`. + # Optional. The rich response messages intended for the end-user. + # When provided, Dialogflow uses this field to populate + # QueryResult.fulfillment_messages sent to the integration or API caller. # Corresponds to the JSON property `fulfillmentMessages` # @return [Array] attr_accessor :fulfillment_messages - # Optional. The text to be shown on the screen. This value is passed directly - # to `QueryResult.fulfillment_text`. + # Optional. The text response message intended for the end-user. + # It is recommended to use `fulfillment_messages.text.text[0]` instead. + # When provided, Dialogflow uses this field to populate + # QueryResult.fulfillment_text sent to the integration or API caller. # Corresponds to the JSON property `fulfillmentText` # @return [String] attr_accessor :fulfillment_text - # Optional. The collection of output contexts. This value is passed directly - # to `QueryResult.output_contexts`. + # Optional. The collection of output contexts that will overwrite currently + # active contexts for the session and reset their lifespans. + # When provided, Dialogflow uses this field to populate + # QueryResult.output_contexts sent to the integration or API caller. # Corresponds to the JSON property `outputContexts` # @return [Array] attr_accessor :output_contexts # Optional. This field can be used to pass custom data from your webhook to the - # API - # caller. Arbitrary JSON objects are supported. + # integration or API caller. Arbitrary JSON objects are supported. # When provided, Dialogflow uses this field to populate - # `QueryResult.webhook_payload` sent to the API caller. + # QueryResult.webhook_payload sent to the integration or API caller. # This field is also used by the # [Google Assistant # integration](https://cloud.google.com/dialogflow/docs/integrations/aog) @@ -2095,14 +2123,17 @@ module Google # Optional. Additional session entity types to replace or extend developer # entity types with. The entity synonyms apply to all languages and persist - # for the session of this query. Setting the session entity types inside - # webhook overwrites the session entity types that have been set through - # `DetectIntentRequest.query_params.session_entity_types`. + # for the session. Setting this data from a webhook overwrites + # the session entity types that have been set using `detectIntent`, + # `streamingDetectIntent` or SessionEntityType management methods. # Corresponds to the JSON property `sessionEntityTypes` # @return [Array] attr_accessor :session_entity_types - # Optional. This value is passed directly to `QueryResult.webhook_source`. + # Optional. A custom field used to identify the webhook source. + # Arbitrary strings are supported. + # When provided, Dialogflow uses this field to populate + # QueryResult.webhook_source sent to the integration or API caller. # Corresponds to the JSON property `source` # @return [String] attr_accessor :source @@ -2606,7 +2637,7 @@ module Google # - MapKey value: parameter name # - MapValue type: # - If parameter's entity type is a composite entity: map - # - Else: string + # - Else: string or number, depending on parameter value type # - MapValue value: # - If parameter's entity type is a composite entity: # map from composite entity property names to property values @@ -2784,17 +2815,40 @@ module Google # @return [String] attr_accessor :display_name + # Optional. If true, we try to automatically reload the document every day + # (at a time picked by the system). If false or unspecified, we don't try + # to automatically reload the document. + # Currently you can only enable automatic reload for documents sourced from + # a public url, see `source` field for the source types. + # Reload status can be tracked in `latest_reload_status`. If a reload + # fails, we will keep the document unchanged. + # If a reload fails with internal errors, the system will try to reload the + # document on the next day. + # If a reload fails with non-retriable errors (e.g. PERMISION_DENIED), the + # system will not try to reload the document anymore. You need to manually + # reload the document successfully by calling `ReloadDocument` and clear the + # errors. + # Corresponds to the JSON property `enableAutoReload` + # @return [Boolean] + attr_accessor :enable_auto_reload + alias_method :enable_auto_reload?, :enable_auto_reload + # Required. The knowledge type of document content. # Corresponds to the JSON property `knowledgeTypes` # @return [Array] attr_accessor :knowledge_types + # The status of a reload attempt. + # Corresponds to the JSON property `latestReloadStatus` + # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DocumentReloadStatus] + attr_accessor :latest_reload_status + # Required. The MIME type of this document. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type - # The document resource name. + # Optional. The document resource name. # The name must be empty when creating a document. # Format: `projects//knowledgeBases//documents/`. @@ -2818,13 +2872,47 @@ module Google @content = args[:content] if args.key?(:content) @content_uri = args[:content_uri] if args.key?(:content_uri) @display_name = args[:display_name] if args.key?(:display_name) + @enable_auto_reload = args[:enable_auto_reload] if args.key?(:enable_auto_reload) @knowledge_types = args[:knowledge_types] if args.key?(:knowledge_types) + @latest_reload_status = args[:latest_reload_status] if args.key?(:latest_reload_status) @mime_type = args[:mime_type] if args.key?(:mime_type) @name = args[:name] if args.key?(:name) @raw_content = args[:raw_content] if args.key?(:raw_content) end end + # The status of a reload attempt. + class GoogleCloudDialogflowV2beta1DocumentReloadStatus + include Google::Apis::Core::Hashable + + # 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). Each `Status` message contains + # three pieces of data: error code, error message, and error details. + # You can find out more about this error model and how to work with it in the + # [API Design Guide](https://cloud.google.com/apis/design/errors). + # Corresponds to the JSON property `status` + # @return [Google::Apis::DialogflowV2beta1::GoogleRpcStatus] + attr_accessor :status + + # Output only. The time of a reload attempt. + # This reload may have been triggered automatically or manually and may + # not have succeeded. + # Corresponds to the JSON property `time` + # @return [String] + attr_accessor :time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @status = args[:status] if args.key?(:status) + @time = args[:time] if args.key?(:time) + end + end + # Represents an entity type. # Entity types serve as a tool for extracting parameter values from natural # language queries. @@ -2936,6 +3024,57 @@ module Google end end + # Represents an agent environment. + class GoogleCloudDialogflowV2beta1Environment + include Google::Apis::Core::Hashable + + # Optional. The agent version loaded into this environment. + # Format: `projects//agent/versions/`. + # Corresponds to the JSON property `agentVersion` + # @return [String] + attr_accessor :agent_version + + # Optional. The developer-provided description for this environment. + # The maximum length is 500 characters. If exceeded, the request is rejected. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Output only. The unique identifier of this agent environment. + # Format: `projects//agent/environments/`. + # For Environment ID, "-" is reserved for 'draft' environment. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. The state of this environment. This field is read-only, i.e., it + # cannot be + # set by create and update methods. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # Output only. The last update time of this environment. This field is read-only, + # i.e., it + # cannot be set by create and update methods. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @agent_version = args[:agent_version] if args.key?(:agent_version) + @description = args[:description] if args.key?(:description) + @name = args[:name] if args.key?(:name) + @state = args[:state] if args.key?(:state) + @update_time = args[:update_time] if args.key?(:update_time) + end + end + # Events allow for matching intents by event name instead of the natural # language input. For instance, input `` can trigger a personalized welcome response. @@ -2958,6 +3097,18 @@ module Google attr_accessor :name # The collection of parameters associated with the event. + # Depending on your protocol or client library language, this is a + # map, associative array, symbol table, dictionary, or JSON object + # composed of a collection of (MapKey, MapValue) pairs: + # - MapKey type: string + # - MapKey value: parameter name + # - MapValue type: + # - If parameter's entity type is a composite entity: map + # - Else: string or number, depending on parameter value type + # - MapValue value: + # - If parameter's entity type is a composite entity: + # map from composite entity property names to property values + # - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters @@ -3121,6 +3272,7 @@ module Google attr_accessor :request_headers # Required. The fulfillment URI for receiving POST requests. + # It must use https protocol. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -3344,7 +3496,7 @@ module Google # @return [Array] attr_accessor :events - # Read-only. Information about all followup intents that have this intent as + # Output only. Information about all followup intents that have this intent as # a direct or indirect parent. We populate this field only in the output. # Corresponds to the JSON property `followupIntentInfo` # @return [Array] @@ -3394,7 +3546,7 @@ module Google attr_accessor :ml_enabled alias_method :ml_enabled?, :ml_enabled - # The unique identifier of this intent. + # Optional. The unique identifier of this intent. # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents # methods. # Format: `projects//agent/intents/`. @@ -3416,7 +3568,7 @@ module Google # @return [Array] attr_accessor :parameters - # Read-only after creation. The unique identifier of the parent intent in the + # Optional. The unique identifier of the parent intent in the # chain of followup intents. You can set this field when creating an intent, # for example with CreateIntent or # BatchUpdateIntents, in order to make this @@ -3427,7 +3579,7 @@ module Google # @return [String] attr_accessor :parent_followup_intent_name - # The priority of this intent. Higher numbers represent higher + # Optional. The priority of this intent. Higher numbers represent higher # priorities. # - If the supplied value is unspecified or 0, the service # translates the value to 500,000, which corresponds to the @@ -3445,9 +3597,9 @@ module Google attr_accessor :reset_contexts alias_method :reset_contexts?, :reset_contexts - # Read-only. The unique identifier of the root intent in the chain of + # Output only. The unique identifier of the root intent in the chain of # followup intents. It identifies the correct followup intents chain for - # this intent. We populate this field only in the output. + # this intent. # Format: `projects//agent/intents/`. # Corresponds to the JSON property `rootFollowupIntentName` # @return [String] @@ -5225,7 +5377,7 @@ module Google class GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata include Google::Apis::Core::Hashable - # Required. The current state of this operation. + # Required. Output only. The current state of this operation. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state @@ -5344,6 +5496,33 @@ module Google end end + # The response message for Environments.ListEnvironments. + class GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + include Google::Apis::Core::Hashable + + # The list of agent environments. There will be a maximum number of items + # returned based on the page_size field in the request. + # Corresponds to the JSON property `environments` + # @return [Array] + attr_accessor :environments + + # Token to retrieve the next page of results, or empty if there are no + # more results in the list. + # 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) + @environments = args[:environments] if args.key?(:environments) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + # The response message for Intents.ListIntents. class GoogleCloudDialogflowV2beta1ListIntentsResponse include Google::Apis::Core::Hashable @@ -5728,6 +5907,18 @@ module Google attr_accessor :output_contexts # The collection of extracted parameters. + # Depending on your protocol or client library language, this is a + # map, associative array, symbol table, dictionary, or JSON object + # composed of a collection of (MapKey, MapValue) pairs: + # - MapKey type: string + # - MapKey value: parameter name + # - MapValue type: + # - If parameter's entity type is a composite entity: map + # - Else: string or number, depending on parameter value type + # - MapValue value: + # - If parameter's entity type is a composite entity: + # map from composite entity property names to property values + # - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters @@ -6329,29 +6520,33 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EventInput] attr_accessor :followup_event_input - # Optional. The collection of rich messages to present to the user. This - # value is passed directly to `QueryResult.fulfillment_messages`. + # Optional. The rich response messages intended for the end-user. + # When provided, Dialogflow uses this field to populate + # QueryResult.fulfillment_messages sent to the integration or API caller. # Corresponds to the JSON property `fulfillmentMessages` # @return [Array] attr_accessor :fulfillment_messages - # Optional. The text to be shown on the screen. This value is passed directly - # to `QueryResult.fulfillment_text`. + # Optional. The text response message intended for the end-user. + # It is recommended to use `fulfillment_messages.text.text[0]` instead. + # When provided, Dialogflow uses this field to populate + # QueryResult.fulfillment_text sent to the integration or API caller. # Corresponds to the JSON property `fulfillmentText` # @return [String] attr_accessor :fulfillment_text - # Optional. The collection of output contexts. This value is passed directly - # to `QueryResult.output_contexts`. + # Optional. The collection of output contexts that will overwrite currently + # active contexts for the session and reset their lifespans. + # When provided, Dialogflow uses this field to populate + # QueryResult.output_contexts sent to the integration or API caller. # Corresponds to the JSON property `outputContexts` # @return [Array] attr_accessor :output_contexts # Optional. This field can be used to pass custom data from your webhook to the - # API - # caller. Arbitrary JSON objects are supported. + # integration or API caller. Arbitrary JSON objects are supported. # When provided, Dialogflow uses this field to populate - # `QueryResult.webhook_payload` sent to the API caller. + # QueryResult.webhook_payload sent to the integration or API caller. # This field is also used by the # [Google Assistant # integration](https://cloud.google.com/dialogflow/docs/integrations/aog) @@ -6365,14 +6560,17 @@ module Google # Optional. Additional session entity types to replace or extend developer # entity types with. The entity synonyms apply to all languages and persist - # for the session of this query. Setting the session entity types inside - # webhook overwrites the session entity types that have been set through - # `DetectIntentRequest.query_params.session_entity_types`. + # for the session. Setting this data from a webhook overwrites + # the session entity types that have been set using `detectIntent`, + # `streamingDetectIntent` or SessionEntityType management methods. # Corresponds to the JSON property `sessionEntityTypes` # @return [Array] attr_accessor :session_entity_types - # Optional. This value is passed directly to `QueryResult.webhook_source`. + # Optional. A custom field used to identify the webhook source. + # Arbitrary strings are supported. + # When provided, Dialogflow uses this field to populate + # QueryResult.webhook_source sent to the integration or API caller. # Corresponds to the JSON property `source` # @return [String] attr_accessor :source @@ -6394,6 +6592,33 @@ module Google end end + # The response message for Agents.ExportAgent. + class GoogleCloudDialogflowV3alpha1ExportAgentResponse + include Google::Apis::Core::Hashable + + # Uncompressed raw byte content for agent. + # Corresponds to the JSON property `agentContent` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :agent_content + + # The URI to a file containing the exported agent. This field is populated + # only if `agent_uri` is specified in ExportAgentRequest. + # Corresponds to the JSON property `agentUri` + # @return [String] + attr_accessor :agent_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @agent_content = args[:agent_content] if args.key?(:agent_content) + @agent_uri = args[:agent_uri] if args.key?(:agent_uri) + end + end + # The response message for Operations.ListOperations. class GoogleLongrunningListOperationsResponse include Google::Apis::Core::Hashable diff --git a/generated/google/apis/dialogflow_v2beta1/representations.rb b/generated/google/apis/dialogflow_v2beta1/representations.rb index f9dd93617..a232cf9d8 100644 --- a/generated/google/apis/dialogflow_v2beta1/representations.rb +++ b/generated/google/apis/dialogflow_v2beta1/representations.rb @@ -418,6 +418,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDialogflowV2beta1DocumentReloadStatus + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDialogflowV2beta1EntityType class Representation < Google::Apis::Core::JsonRepresentation; end @@ -436,6 +442,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDialogflowV2beta1Environment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDialogflowV2beta1EventInput class Representation < Google::Apis::Core::JsonRepresentation; end @@ -826,6 +838,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDialogflowV2beta1ListIntentsResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -976,6 +994,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDialogflowV3alpha1ExportAgentResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleLongrunningListOperationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1718,13 +1742,25 @@ module Google property :content, as: 'content' property :content_uri, as: 'contentUri' property :display_name, as: 'displayName' + property :enable_auto_reload, as: 'enableAutoReload' collection :knowledge_types, as: 'knowledgeTypes' + property :latest_reload_status, as: 'latestReloadStatus', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DocumentReloadStatus, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DocumentReloadStatus::Representation + property :mime_type, as: 'mimeType' property :name, as: 'name' property :raw_content, :base64 => true, as: 'rawContent' end end + class GoogleCloudDialogflowV2beta1DocumentReloadStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :status, as: 'status', class: Google::Apis::DialogflowV2beta1::GoogleRpcStatus, decorator: Google::Apis::DialogflowV2beta1::GoogleRpcStatus::Representation + + property :time, as: 'time' + end + end + class GoogleCloudDialogflowV2beta1EntityType # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1754,6 +1790,17 @@ module Google end end + class GoogleCloudDialogflowV2beta1Environment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :agent_version, as: 'agentVersion' + property :description, as: 'description' + property :name, as: 'name' + property :state, as: 'state' + property :update_time, as: 'updateTime' + end + end + class GoogleCloudDialogflowV2beta1EventInput # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2414,6 +2461,15 @@ module Google end end + class GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :environments, as: 'environments', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + class GoogleCloudDialogflowV2beta1ListIntentsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2677,6 +2733,14 @@ module Google end end + class GoogleCloudDialogflowV3alpha1ExportAgentResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :agent_content, :base64 => true, as: 'agentContent' + property :agent_uri, as: 'agentUri' + end + end + class GoogleLongrunningListOperationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/dialogflow_v2beta1/service.rb b/generated/google/apis/dialogflow_v2beta1/service.rb index 194d5bd18..581bfa02f 100644 --- a/generated/google/apis/dialogflow_v2beta1/service.rb +++ b/generated/google/apis/dialogflow_v2beta1/service.rb @@ -826,6 +826,45 @@ module Google execute_or_queue_command(command, &block) end + # Returns the list of all non-draft environments of the specified agent. + # @param [String] parent + # Required. The agent to list all environments from. + # Format: `projects//agent`. + # @param [Fixnum] page_size + # Optional. The maximum number of items to return in a single page. By default + # 100 and + # at most 1000. + # @param [String] page_token + # Optional. The next_page_token value returned from a previous list request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListEnvironmentsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListEnvironmentsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_agent_environments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+parent}/environments', options) + command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListEnvironmentsResponse::Representation + command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Deletes all active contexts in the specified session. # @param [String] parent # Required. The name of the session to delete all contexts from. Format: @@ -1554,7 +1593,7 @@ module Google # Updates the specified intent. # @param [String] name - # The unique identifier of this intent. + # Optional. The unique identifier of this intent. # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents # methods. # Format: `projects//agent/intents/`. @@ -1794,7 +1833,7 @@ module Google # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; # only use `projects.knowledgeBases.documents`. # @param [String] parent - # Required. The knoweldge base to create a document for. + # The knoweldge base to create a document for. # Format: `projects//knowledgeBases/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document] google_cloud_dialogflow_v2beta1_document_object # @param [String] fields @@ -1830,7 +1869,7 @@ module Google # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; # only use `projects.knowledgeBases.documents`. # @param [String] name - # The name of the document to delete. + # Required. The name of the document to delete. # Format: `projects//knowledgeBases//documents/`. # @param [String] fields @@ -1938,7 +1977,7 @@ module Google # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; # only use `projects.knowledgeBases.documents`. # @param [String] name - # The document resource name. + # Optional. The document resource name. # The name must be empty when creating a document. # Format: `projects//knowledgeBases//documents/`. @@ -1984,7 +2023,7 @@ module Google # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; # only use `projects.knowledgeBases.documents`. # @param [String] name - # The name of the document to reload. + # Required. The name of the document to reload. # Format: `projects//knowledgeBases//documents/` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ReloadDocumentRequest] google_cloud_dialogflow_v2beta1_reload_document_request_object @@ -2697,7 +2736,7 @@ module Google # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; # only use `projects.knowledgeBases.documents`. # @param [String] parent - # Required. The knoweldge base to create a document for. + # The knoweldge base to create a document for. # Format: `projects//knowledgeBases/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document] google_cloud_dialogflow_v2beta1_document_object # @param [String] fields @@ -2733,7 +2772,7 @@ module Google # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; # only use `projects.knowledgeBases.documents`. # @param [String] name - # The name of the document to delete. + # Required. The name of the document to delete. # Format: `projects//knowledgeBases//documents/`. # @param [String] fields @@ -2841,7 +2880,7 @@ module Google # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; # only use `projects.knowledgeBases.documents`. # @param [String] name - # The document resource name. + # Optional. The document resource name. # The name must be empty when creating a document. # Format: `projects//knowledgeBases//documents/`. @@ -2887,7 +2926,7 @@ module Google # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; # only use `projects.knowledgeBases.documents`. # @param [String] name - # The name of the document to reload. + # Required. The name of the document to reload. # Format: `projects//knowledgeBases//documents/` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ReloadDocumentRequest] google_cloud_dialogflow_v2beta1_reload_document_request_object @@ -3615,6 +3654,45 @@ module Google execute_or_queue_command(command, &block) end + # Returns the list of all non-draft environments of the specified agent. + # @param [String] parent + # Required. The agent to list all environments from. + # Format: `projects//agent`. + # @param [Fixnum] page_size + # Optional. The maximum number of items to return in a single page. By default + # 100 and + # at most 1000. + # @param [String] page_token + # Optional. The next_page_token value returned from a previous list request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListEnvironmentsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListEnvironmentsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_agent_environments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+parent}/environments', options) + command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListEnvironmentsResponse::Representation + command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Deletes all active contexts in the specified session. # @param [String] parent # Required. The name of the session to delete all contexts from. Format: @@ -4343,7 +4421,7 @@ module Google # Updates the specified intent. # @param [String] name - # The unique identifier of this intent. + # Optional. The unique identifier of this intent. # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents # methods. # Format: `projects//agent/intents/`. diff --git a/generated/google/apis/displayvideo_v1.rb b/generated/google/apis/displayvideo_v1.rb index fe832e47e..3f6ed1f6f 100644 --- a/generated/google/apis/displayvideo_v1.rb +++ b/generated/google/apis/displayvideo_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/display-video/ module DisplayvideoV1 VERSION = 'V1' - REVISION = '20200302' + REVISION = '20200505' # Create, see, edit, and permanently delete your Display & Video 360 entities and reports AUTH_DISPLAY_VIDEO = 'https://www.googleapis.com/auth/display-video' diff --git a/generated/google/apis/displayvideo_v1/classes.rb b/generated/google/apis/displayvideo_v1/classes.rb index d51489fce..65deb302c 100644 --- a/generated/google/apis/displayvideo_v1/classes.rb +++ b/generated/google/apis/displayvideo_v1/classes.rb @@ -22,6 +22,2039 @@ module Google module Apis module DisplayvideoV1 + # Configuration for custom Active View video viewability metrics. + class ActiveViewVideoViewabilityMetricConfig + include Google::Apis::Core::Hashable + + # Required. The display name of the custom metric. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # The minimum visible video duration required (in seconds) in order for an + # impression to be recorded. + # You must specify + # minimum_duration, + # minimum_quartile + # or both. If both are specified, an impression meets the metric criteria if + # either requirement is met (whichever happens first). + # Corresponds to the JSON property `minimumDuration` + # @return [String] + attr_accessor :minimum_duration + + # The minimum visible video duration required, based on the video quartiles, + # in order for an impression to be recorded. + # You must specify + # minimum_duration, + # minimum_quartile + # or both. If both are specified, an impression meets the metric criteria if + # either requirement is met (whichever happens first). + # Corresponds to the JSON property `minimumQuartile` + # @return [String] + attr_accessor :minimum_quartile + + # Required. The minimum percentage of the video ad's pixels visible on the + # screen in + # order for an impression to be recorded. + # Corresponds to the JSON property `minimumViewability` + # @return [String] + attr_accessor :minimum_viewability + + # Required. The minimum percentage of the video ad's volume required in order + # for an + # impression to be recorded. + # Corresponds to the JSON property `minimumVolume` + # @return [String] + attr_accessor :minimum_volume + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + @minimum_duration = args[:minimum_duration] if args.key?(:minimum_duration) + @minimum_quartile = args[:minimum_quartile] if args.key?(:minimum_quartile) + @minimum_viewability = args[:minimum_viewability] if args.key?(:minimum_viewability) + @minimum_volume = args[:minimum_volume] if args.key?(:minimum_volume) + end + end + + # Details of Adloox settings. + class Adloox + include Google::Apis::Core::Hashable + + # Adloox's brand safety settings. + # Corresponds to the JSON property `excludedAdlooxCategories` + # @return [Array] + attr_accessor :excluded_adloox_categories + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @excluded_adloox_categories = args[:excluded_adloox_categories] if args.key?(:excluded_adloox_categories) + end + end + + # A single advertiser in Display & Video 360 (DV360). + class Advertiser + include Google::Apis::Core::Hashable + + # Ad server related settings of an advertiser. + # Corresponds to the JSON property `adServerConfig` + # @return [Google::Apis::DisplayvideoV1::AdvertiserAdServerConfig] + attr_accessor :ad_server_config + + # Output only. The unique ID of the advertiser. Assigned by the system. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Creatives related settings of an advertiser. + # Corresponds to the JSON property `creativeConfig` + # @return [Google::Apis::DisplayvideoV1::AdvertiserCreativeConfig] + attr_accessor :creative_config + + # Settings that control how advertiser related data may be accessed. + # Corresponds to the JSON property `dataAccessConfig` + # @return [Google::Apis::DisplayvideoV1::AdvertiserDataAccessConfig] + attr_accessor :data_access_config + + # Required. The display name of the advertiser. + # Must be UTF-8 encoded with a maximum size of 240 bytes. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Required. Controls whether or not insertion orders and line items of the + # advertiser can spend their budgets and bid on inventory. + # * Accepted values are `ENTITY_STATUS_ACTIVE` and + # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. + # * If set to + # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 + # days from when it was first scheduled for deletion. + # Corresponds to the JSON property `entityStatus` + # @return [String] + attr_accessor :entity_status + + # General settings of an advertiser. + # Corresponds to the JSON property `generalConfig` + # @return [Google::Apis::DisplayvideoV1::AdvertiserGeneralConfig] + attr_accessor :general_config + + # Integration details of an entry. + # Corresponds to the JSON property `integrationDetails` + # @return [Google::Apis::DisplayvideoV1::IntegrationDetails] + attr_accessor :integration_details + + # Output only. The resource name of the advertiser. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Required. Immutable. The unique ID of the partner that the advertiser belongs + # to. + # Corresponds to the JSON property `partnerId` + # @return [Fixnum] + attr_accessor :partner_id + + # Output only. The timestamp when the advertiser was last updated. Assigned by + # the system. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ad_server_config = args[:ad_server_config] if args.key?(:ad_server_config) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @creative_config = args[:creative_config] if args.key?(:creative_config) + @data_access_config = args[:data_access_config] if args.key?(:data_access_config) + @display_name = args[:display_name] if args.key?(:display_name) + @entity_status = args[:entity_status] if args.key?(:entity_status) + @general_config = args[:general_config] if args.key?(:general_config) + @integration_details = args[:integration_details] if args.key?(:integration_details) + @name = args[:name] if args.key?(:name) + @partner_id = args[:partner_id] if args.key?(:partner_id) + @update_time = args[:update_time] if args.key?(:update_time) + end + end + + # Ad server related settings of an advertiser. + class AdvertiserAdServerConfig + include Google::Apis::Core::Hashable + + # Settings for advertisers that use both Campaign Manager (CM) and third-party + # ad servers. + # Corresponds to the JSON property `cmHybridConfig` + # @return [Google::Apis::DisplayvideoV1::CmHybridConfig] + attr_accessor :cm_hybrid_config + + # Settings for advertisers that use third-party ad servers only. + # Corresponds to the JSON property `thirdPartyOnlyConfig` + # @return [Google::Apis::DisplayvideoV1::ThirdPartyOnlyConfig] + attr_accessor :third_party_only_config + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cm_hybrid_config = args[:cm_hybrid_config] if args.key?(:cm_hybrid_config) + @third_party_only_config = args[:third_party_only_config] if args.key?(:third_party_only_config) + end + end + + # Creatives related settings of an advertiser. + class AdvertiserCreativeConfig + include Google::Apis::Core::Hashable + + # Whether or not the advertiser is enabled for dynamic creatives. + # Corresponds to the JSON property `dynamicCreativeEnabled` + # @return [Boolean] + attr_accessor :dynamic_creative_enabled + alias_method :dynamic_creative_enabled?, :dynamic_creative_enabled + + # An ID for configuring campaign monitoring provided by Integral Ad Service + # (IAS). The DV360 system will append an IAS "Campaign Monitor" tag + # containing this ID to the creative tag. + # Corresponds to the JSON property `iasClientId` + # @return [Fixnum] + attr_accessor :ias_client_id + + # Whether or not to use DV360's Online Behavioral Advertising (OBA) + # compliance. + # Warning: Changing OBA settings may cause the audit status of your creatives + # to be reset by some ad exchanges, making them ineligible to serve until + # they are re-approved. + # Corresponds to the JSON property `obaComplianceDisabled` + # @return [Boolean] + attr_accessor :oba_compliance_disabled + alias_method :oba_compliance_disabled?, :oba_compliance_disabled + + # By setting this field to `true`, you, on behalf of your company, + # authorize Google to use video creatives associated with this Display & + # Video 360 advertiser to provide reporting and features related to the + # advertiser's television campaigns. + # Applicable only when the advertiser has a + # CM hybrid ad server + # configuration. + # Corresponds to the JSON property `videoCreativeDataSharingAuthorized` + # @return [Boolean] + attr_accessor :video_creative_data_sharing_authorized + alias_method :video_creative_data_sharing_authorized?, :video_creative_data_sharing_authorized + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dynamic_creative_enabled = args[:dynamic_creative_enabled] if args.key?(:dynamic_creative_enabled) + @ias_client_id = args[:ias_client_id] if args.key?(:ias_client_id) + @oba_compliance_disabled = args[:oba_compliance_disabled] if args.key?(:oba_compliance_disabled) + @video_creative_data_sharing_authorized = args[:video_creative_data_sharing_authorized] if args.key?(:video_creative_data_sharing_authorized) + end + end + + # Settings that control how advertiser related data may be accessed. + class AdvertiserDataAccessConfig + include Google::Apis::Core::Hashable + + # Structured Data Files (SDF) settings of an advertiser. + # Corresponds to the JSON property `sdfConfig` + # @return [Google::Apis::DisplayvideoV1::AdvertiserSdfConfig] + attr_accessor :sdf_config + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @sdf_config = args[:sdf_config] if args.key?(:sdf_config) + end + end + + # General settings of an advertiser. + class AdvertiserGeneralConfig + include Google::Apis::Core::Hashable + + # Required. Immutable. Advertiser's currency in ISO 4217 format. + # Accepted codes and the currencies they represent are: + # Currency Code : Currency Name + # * `ARS` : Argentine Peso + # * `AUD` : Australian Dollar + # * `BRL` : Brazilian Real + # * `CAD` : Canadian Dollar + # * `CHF` : Swiss Franc + # * `CLP` : Chilean Peso + # * `CNY` : Chinese Yuan + # * `COP` : Colombian Peso + # * `CZK` : Czech Koruna + # * `DKK` : Danish Krone + # * `EGP` : Egyption Pound + # * `EUR` : Euro + # * `GBP` : British Pound + # * `HKD` : Hong Kong Dollar + # * `HUF` : Hungarian Forint + # * `IDR` : Indonesian Rupiah + # * `ILS` : Israeli Shekel + # * `INR` : Indian Rupee + # * `JPY` : Japanese Yen + # * `KRW` : South Korean Won + # * `MXN` : Mexican Pesos + # * `MYR` : Malaysian Ringgit + # * `NGN` : Nigerian Naira + # * `NOK` : Norwegian Krone + # * `NZD` : New Zealand Dollar + # * `PEN` : Peruvian Nuevo Sol + # * `PLN` : Polish Zloty + # * `RON` : New Romanian Leu + # * `RUB` : Russian Ruble + # * `SEK` : Swedish Krona + # * `TRY` : Turkish Lira + # * `TWD` : New Taiwan Dollar + # * `USD` : US Dollar + # * `ZAR` : South African Rand + # Corresponds to the JSON property `currencyCode` + # @return [String] + attr_accessor :currency_code + + # Required. The domain URL of the advertiser's primary website. + # The system will send this information to publishers that require website + # URL to associate a campaign with an advertiser. + # Provide a URL with no path or query string, beginning with `http:` or + # `https:`. + # For example, http://www.example.com + # Corresponds to the JSON property `domainUrl` + # @return [String] + attr_accessor :domain_url + + # Output only. The standard TZ database name of the advertiser's time zone. + # For example, `America/New_York`. + # See more at: + # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones + # For CM hybrid advertisers, the time zone is the same as that of the + # associated CM account; for third-party only advertisers, the time zone is + # the same as that of the parent partner. + # Corresponds to the JSON property `timeZone` + # @return [String] + attr_accessor :time_zone + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @currency_code = args[:currency_code] if args.key?(:currency_code) + @domain_url = args[:domain_url] if args.key?(:domain_url) + @time_zone = args[:time_zone] if args.key?(:time_zone) + end + end + + # Structured Data Files (SDF) settings of an advertiser. + class AdvertiserSdfConfig + include Google::Apis::Core::Hashable + + # Whether or not this advertiser overrides the SDF configuration of its + # parent partner. + # By default, an advertiser inherits the SDF configuration from the parent + # partner. To override the partner configuration, set this field to `true` + # and provide the new configuration in + # sdfConfig. + # Corresponds to the JSON property `overridePartnerSdfConfig` + # @return [Boolean] + attr_accessor :override_partner_sdf_config + alias_method :override_partner_sdf_config?, :override_partner_sdf_config + + # Structured Data File (SDF) related settings. + # Corresponds to the JSON property `sdfConfig` + # @return [Google::Apis::DisplayvideoV1::SdfConfig] + attr_accessor :sdf_config + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @override_partner_sdf_config = args[:override_partner_sdf_config] if args.key?(:override_partner_sdf_config) + @sdf_config = args[:sdf_config] if args.key?(:sdf_config) + end + end + + # Represents a targetable age range. This will be populated in the details + # field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_AGE_RANGE`. + class AgeRangeAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The age range of an audience. We only support targeting a + # continuous age + # range of an audience. Thus, the age range represented in this field can be + # 1) targeted solely, or, 2) part of a larger continuous age range. The reach + # of a continuous age range targeting can be expanded by also targeting an + # audience of an unknown age. + # Corresponds to the JSON property `ageRange` + # @return [String] + attr_accessor :age_range + + # Required. The targeting_option_id of a + # TargetingOption of type `TARGETING_TYPE_AGE_RANGE`. + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @age_range = args[:age_range] if args.key?(:age_range) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + end + end + + # Represents a targetable age range. This will be populated in the + # age_range_details field when + # targeting_type is + # `TARGETING_TYPE_AGE_RANGE`. + class AgeRangeTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The age range of an audience. + # Corresponds to the JSON property `ageRange` + # @return [String] + attr_accessor :age_range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @age_range = args[:age_range] if args.key?(:age_range) + end + end + + # Details for assigned app targeting option. This will be populated in the + # details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_APP`. + class AppAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Required. The ID of the app. + # Android's Play store app uses bundle ID, for example + # `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for + # example `422689480`. + # Corresponds to the JSON property `appId` + # @return [String] + attr_accessor :app_id + + # Output only. The display name of the app. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Indicates if this option is being negatively targeted. + # Corresponds to the JSON property `negative` + # @return [Boolean] + attr_accessor :negative + alias_method :negative?, :negative + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @app_id = args[:app_id] if args.key?(:app_id) + @display_name = args[:display_name] if args.key?(:display_name) + @negative = args[:negative] if args.key?(:negative) + end + end + + # Details for assigned app category targeting option. This will be + # populated in the + # app_category_details field of + # an AssignedTargetingOption when + # targeting_type + # is `TARGETING_TYPE_APP_CATEGORY`. + class AppCategoryAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The display name of the app category. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Indicates if this option is being negatively targeted. + # Corresponds to the JSON property `negative` + # @return [Boolean] + attr_accessor :negative + alias_method :negative?, :negative + + # Required. The targeting_option_id field when + # targeting_type is + # `TARGETING_TYPE_APP_CATEGORY`. + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + @negative = args[:negative] if args.key?(:negative) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + end + end + + # Represents a targetable collection of apps. A collection lets you target + # dynamic groups of related apps that are maintained by the platform, for + # example `All Apps/Google Play/Games`. This will be populated in the + # app_category_details field when + # targeting_type is + # `TARGETING_TYPE_APP_CATEGORY`. + class AppCategoryTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The name of the app collection. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + end + end + + # A single asset. + class Asset + include Google::Apis::Core::Hashable + + # The asset content. + # For uploaded assets, the content is the serving path. + # Corresponds to the JSON property `content` + # @return [String] + attr_accessor :content + + # Media ID of the uploaded asset. This is a unique identifier for the asset. + # This ID can be passed to other API calls, e.g. + # CreateCreative to associate + # the asset with a creative. + # Corresponds to the JSON property `mediaId` + # @return [Fixnum] + attr_accessor :media_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content = args[:content] if args.key?(:content) + @media_id = args[:media_id] if args.key?(:media_id) + end + end + + # Asset association for the creative. + class AssetAssociation + include Google::Apis::Core::Hashable + + # A single asset. + # Corresponds to the JSON property `asset` + # @return [Google::Apis::DisplayvideoV1::Asset] + attr_accessor :asset + + # The role of this asset for the creative. + # 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) + @asset = args[:asset] if args.key?(:asset) + @role = args[:role] if args.key?(:role) + end + end + + # A single assigned targeting option, which defines the state of a targeting + # option for an entity with targeting settings, such as a Line Item or + # Insertion Order. + class AssignedTargetingOption + include Google::Apis::Core::Hashable + + # Represents a targetable age range. This will be populated in the details + # field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_AGE_RANGE`. + # Corresponds to the JSON property `ageRangeDetails` + # @return [Google::Apis::DisplayvideoV1::AgeRangeAssignedTargetingOptionDetails] + attr_accessor :age_range_details + + # Details for assigned app category targeting option. This will be + # populated in the + # app_category_details field of + # an AssignedTargetingOption when + # targeting_type + # is `TARGETING_TYPE_APP_CATEGORY`. + # Corresponds to the JSON property `appCategoryDetails` + # @return [Google::Apis::DisplayvideoV1::AppCategoryAssignedTargetingOptionDetails] + attr_accessor :app_category_details + + # Details for assigned app targeting option. This will be populated in the + # details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_APP`. + # Corresponds to the JSON property `appDetails` + # @return [Google::Apis::DisplayvideoV1::AppAssignedTargetingOptionDetails] + attr_accessor :app_details + + # Output only. The unique ID of the assigned targeting option. The ID is only + # unique + # within a given line item and targeting type. It may be reused in other + # contexts. + # Corresponds to the JSON property `assignedTargetingOptionId` + # @return [String] + attr_accessor :assigned_targeting_option_id + + # Assigned audience group targeting option details. This will be populated in + # the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_AUDIENCE_GROUP`. + # The relation between each group is UNION, except for + # excluded_first_and_third_party_audience_group and + # excluded_google_audience_group, of which COMPLEMENT is UNION'ed with other + # groups. + # Corresponds to the JSON property `audienceGroupDetails` + # @return [Google::Apis::DisplayvideoV1::AudienceGroupAssignedTargetingOptionDetails] + attr_accessor :audience_group_details + + # Represents an assigned authorized seller status. This will be populated in + # the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. + # Corresponds to the JSON property `authorizedSellerStatusDetails` + # @return [Google::Apis::DisplayvideoV1::AuthorizedSellerStatusAssignedTargetingOptionDetails] + attr_accessor :authorized_seller_status_details + + # Details for assigned browser targeting option. This will be populated in + # the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_BROWSER`. + # Corresponds to the JSON property `browserDetails` + # @return [Google::Apis::DisplayvideoV1::BrowserAssignedTargetingOptionDetails] + attr_accessor :browser_details + + # Details for assigned carrier and ISP targeting option. This will be populated + # in the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_CARRIER_AND_ISP`. + # Corresponds to the JSON property `carrierAndIspDetails` + # @return [Google::Apis::DisplayvideoV1::CarrierAndIspAssignedTargetingOptionDetails] + attr_accessor :carrier_and_isp_details + + # Assigned category targeting option details. This will be populated in the + # category_details field when + # targeting_type is + # `TARGETING_TYPE_CATEGORY`. + # Corresponds to the JSON property `categoryDetails` + # @return [Google::Apis::DisplayvideoV1::CategoryAssignedTargetingOptionDetails] + attr_accessor :category_details + + # Details for assigned channel targeting option. This will be populated in + # the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_CHANNEL`. + # Corresponds to the JSON property `channelDetails` + # @return [Google::Apis::DisplayvideoV1::ChannelAssignedTargetingOptionDetails] + attr_accessor :channel_details + + # Assigned content instream position targeting option details. This will be + # populated in the + # content_instream_position_details + # field when + # targeting_type is + # `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. + # Corresponds to the JSON property `contentInstreamPositionDetails` + # @return [Google::Apis::DisplayvideoV1::ContentInstreamPositionAssignedTargetingOptionDetails] + attr_accessor :content_instream_position_details + + # Assigned content outstream position targeting option details. This will be + # populated in the + # content_outstream_position_details + # field when + # targeting_type is + # `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. + # Corresponds to the JSON property `contentOutstreamPositionDetails` + # @return [Google::Apis::DisplayvideoV1::ContentOutstreamPositionAssignedTargetingOptionDetails] + attr_accessor :content_outstream_position_details + + # Representation of a segment of time defined on a specific day of the week and + # with a start and end time. + # The time represented by `start_hour` must be before the time represented by + # `end_hour`. + # Corresponds to the JSON property `dayAndTimeDetails` + # @return [Google::Apis::DisplayvideoV1::DayAndTimeAssignedTargetingOptionDetails] + attr_accessor :day_and_time_details + + # Assigned device make and model targeting option details. This will be + # populated in the + # device_make_model_details + # field when + # targeting_type is + # `TARGETING_TYPE_DEVICE_MAKE_MODEL`. + # Corresponds to the JSON property `deviceMakeModelDetails` + # @return [Google::Apis::DisplayvideoV1::DeviceMakeModelAssignedTargetingOptionDetails] + attr_accessor :device_make_model_details + + # Targeting details for device type. This will be + # populated in the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_DEVICE_TYPE`. + # Corresponds to the JSON property `deviceTypeDetails` + # @return [Google::Apis::DisplayvideoV1::DeviceTypeAssignedTargetingOptionDetails] + attr_accessor :device_type_details + + # Targeting details for digital content label. This will be + # populated in the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. + # Corresponds to the JSON property `digitalContentLabelExclusionDetails` + # @return [Google::Apis::DisplayvideoV1::DigitalContentLabelAssignedTargetingOptionDetails] + attr_accessor :digital_content_label_exclusion_details + + # Assigned environment targeting option details. This will be populated + # in the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_ENVIRONMENT`. + # Corresponds to the JSON property `environmentDetails` + # @return [Google::Apis::DisplayvideoV1::EnvironmentAssignedTargetingOptionDetails] + attr_accessor :environment_details + + # Details for assigned exchange targeting option. This will be populated in + # the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_EXCHANGE`. + # Corresponds to the JSON property `exchangeDetails` + # @return [Google::Apis::DisplayvideoV1::ExchangeAssignedTargetingOptionDetails] + attr_accessor :exchange_details + + # Details for assigned gender targeting option. This will be populated in + # the details field of an AssignedTargetingOption when + # targeting_type is + # `TARTGETING_TYPE_GENDER`. + # Corresponds to the JSON property `genderDetails` + # @return [Google::Apis::DisplayvideoV1::GenderAssignedTargetingOptionDetails] + attr_accessor :gender_details + + # Details for assigned geographic region targeting option. This will be + # populated in the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_GEO_REGION`. + # Corresponds to the JSON property `geoRegionDetails` + # @return [Google::Apis::DisplayvideoV1::GeoRegionAssignedTargetingOptionDetails] + attr_accessor :geo_region_details + + # Details for assigned household income targeting option. This will be + # populated in the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_HOUSEHOLD_INCOME`. + # Corresponds to the JSON property `householdIncomeDetails` + # @return [Google::Apis::DisplayvideoV1::HouseholdIncomeAssignedTargetingOptionDetails] + attr_accessor :household_income_details + + # Output only. The inheritance status of the assigned targeting option. + # Corresponds to the JSON property `inheritance` + # @return [String] + attr_accessor :inheritance + + # Targeting details for inventory source. This will be + # populated in the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_INVENTORY_SOURCE`. + # Corresponds to the JSON property `inventorySourceDetails` + # @return [Google::Apis::DisplayvideoV1::InventorySourceAssignedTargetingOptionDetails] + attr_accessor :inventory_source_details + + # Targeting details for inventory source group. This will be + # populated in the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. + # Corresponds to the JSON property `inventorySourceGroupDetails` + # @return [Google::Apis::DisplayvideoV1::InventorySourceGroupAssignedTargetingOptionDetails] + attr_accessor :inventory_source_group_details + + # Details for assigned keyword targeting option. This will be populated in the + # details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_KEYWORD`. + # Corresponds to the JSON property `keywordDetails` + # @return [Google::Apis::DisplayvideoV1::KeywordAssignedTargetingOptionDetails] + attr_accessor :keyword_details + + # Details for assigned language targeting option. This will be populated in the + # details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_LANGUAGE`. + # Corresponds to the JSON property `languageDetails` + # @return [Google::Apis::DisplayvideoV1::LanguageAssignedTargetingOptionDetails] + attr_accessor :language_details + + # Output only. The resource name for this assigned targeting option. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Targeting details for negative keyword list. This will be populated in the + # details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. + # Corresponds to the JSON property `negativeKeywordListDetails` + # @return [Google::Apis::DisplayvideoV1::NegativeKeywordListAssignedTargetingOptionDetails] + attr_accessor :negative_keyword_list_details + + # On screen position targeting option details. This will be + # populated in the + # on_screen_position_details + # field when + # targeting_type is + # `TARGETING_TYPE_ON_SCREEN_POSITION`. + # Corresponds to the JSON property `onScreenPositionDetails` + # @return [Google::Apis::DisplayvideoV1::OnScreenPositionAssignedTargetingOptionDetails] + attr_accessor :on_screen_position_details + + # Assigned operating system targeting option details. This will be + # populated in the + # operating_system_details + # field when + # targeting_type is + # `TARGETING_TYPE_OPERATING_SYSTEM`. + # Corresponds to the JSON property `operatingSystemDetails` + # @return [Google::Apis::DisplayvideoV1::OperatingSystemAssignedTargetingOptionDetails] + attr_accessor :operating_system_details + + # Details for assigned parental status targeting option. This will be + # populated in the details field of an AssignedTargetingOption when + # targeting_type is + # `TARTGETING_TYPE_PARENTAL_STATUS`. + # Corresponds to the JSON property `parentalStatusDetails` + # @return [Google::Apis::DisplayvideoV1::ParentalStatusAssignedTargetingOptionDetails] + attr_accessor :parental_status_details + + # Targeting details for proximity location list. This will be + # populated in the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. + # Corresponds to the JSON property `proximityLocationListDetails` + # @return [Google::Apis::DisplayvideoV1::ProximityLocationListAssignedTargetingOptionDetails] + attr_accessor :proximity_location_list_details + + # Targeting details for regional location list. This will be + # populated in the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. + # Corresponds to the JSON property `regionalLocationListDetails` + # @return [Google::Apis::DisplayvideoV1::RegionalLocationListAssignedTargetingOptionDetails] + attr_accessor :regional_location_list_details + + # Targeting details for sensitive category. This will be populated in the + # details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. + # Corresponds to the JSON property `sensitiveCategoryExclusionDetails` + # @return [Google::Apis::DisplayvideoV1::SensitiveCategoryAssignedTargetingOptionDetails] + attr_accessor :sensitive_category_exclusion_details + + # Details for assigned sub-exchange targeting option. This will be populated in + # the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_SUB_EXCHANGE`. + # Corresponds to the JSON property `subExchangeDetails` + # @return [Google::Apis::DisplayvideoV1::SubExchangeAssignedTargetingOptionDetails] + attr_accessor :sub_exchange_details + + # Output only. Identifies the type of this assigned targeting option. + # Corresponds to the JSON property `targetingType` + # @return [String] + attr_accessor :targeting_type + + # Assigned third party verifier targeting option details. This will be + # populated in the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. + # Corresponds to the JSON property `thirdPartyVerifierDetails` + # @return [Google::Apis::DisplayvideoV1::ThirdPartyVerifierAssignedTargetingOptionDetails] + attr_accessor :third_party_verifier_details + + # Details for assigned URL targeting option. This will be populated in the + # details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_URL`. + # Corresponds to the JSON property `urlDetails` + # @return [Google::Apis::DisplayvideoV1::UrlAssignedTargetingOptionDetails] + attr_accessor :url_details + + # User rewarded content targeting option details. This will be populated in + # the + # user_rewarded_content_details + # field when + # targeting_type is + # `TARGETING_TYPE_USER_REWARDED_CONTENT`. + # Corresponds to the JSON property `userRewardedContentDetails` + # @return [Google::Apis::DisplayvideoV1::UserRewardedContentAssignedTargetingOptionDetails] + attr_accessor :user_rewarded_content_details + + # Video player size targeting option details. This will be populated in the + # video_player_size_details + # field when targeting_type is + # `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. + # Explicitly targeting all options is not supported. Remove all video player + # size targeting options to achieve this effect. + # Corresponds to the JSON property `videoPlayerSizeDetails` + # @return [Google::Apis::DisplayvideoV1::VideoPlayerSizeAssignedTargetingOptionDetails] + attr_accessor :video_player_size_details + + # Assigned viewability targeting option details. This will be populated in the + # viewability_details field of + # an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_VIEWABILITY`. + # Corresponds to the JSON property `viewabilityDetails` + # @return [Google::Apis::DisplayvideoV1::ViewabilityAssignedTargetingOptionDetails] + attr_accessor :viewability_details + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @age_range_details = args[:age_range_details] if args.key?(:age_range_details) + @app_category_details = args[:app_category_details] if args.key?(:app_category_details) + @app_details = args[:app_details] if args.key?(:app_details) + @assigned_targeting_option_id = args[:assigned_targeting_option_id] if args.key?(:assigned_targeting_option_id) + @audience_group_details = args[:audience_group_details] if args.key?(:audience_group_details) + @authorized_seller_status_details = args[:authorized_seller_status_details] if args.key?(:authorized_seller_status_details) + @browser_details = args[:browser_details] if args.key?(:browser_details) + @carrier_and_isp_details = args[:carrier_and_isp_details] if args.key?(:carrier_and_isp_details) + @category_details = args[:category_details] if args.key?(:category_details) + @channel_details = args[:channel_details] if args.key?(:channel_details) + @content_instream_position_details = args[:content_instream_position_details] if args.key?(:content_instream_position_details) + @content_outstream_position_details = args[:content_outstream_position_details] if args.key?(:content_outstream_position_details) + @day_and_time_details = args[:day_and_time_details] if args.key?(:day_and_time_details) + @device_make_model_details = args[:device_make_model_details] if args.key?(:device_make_model_details) + @device_type_details = args[:device_type_details] if args.key?(:device_type_details) + @digital_content_label_exclusion_details = args[:digital_content_label_exclusion_details] if args.key?(:digital_content_label_exclusion_details) + @environment_details = args[:environment_details] if args.key?(:environment_details) + @exchange_details = args[:exchange_details] if args.key?(:exchange_details) + @gender_details = args[:gender_details] if args.key?(:gender_details) + @geo_region_details = args[:geo_region_details] if args.key?(:geo_region_details) + @household_income_details = args[:household_income_details] if args.key?(:household_income_details) + @inheritance = args[:inheritance] if args.key?(:inheritance) + @inventory_source_details = args[:inventory_source_details] if args.key?(:inventory_source_details) + @inventory_source_group_details = args[:inventory_source_group_details] if args.key?(:inventory_source_group_details) + @keyword_details = args[:keyword_details] if args.key?(:keyword_details) + @language_details = args[:language_details] if args.key?(:language_details) + @name = args[:name] if args.key?(:name) + @negative_keyword_list_details = args[:negative_keyword_list_details] if args.key?(:negative_keyword_list_details) + @on_screen_position_details = args[:on_screen_position_details] if args.key?(:on_screen_position_details) + @operating_system_details = args[:operating_system_details] if args.key?(:operating_system_details) + @parental_status_details = args[:parental_status_details] if args.key?(:parental_status_details) + @proximity_location_list_details = args[:proximity_location_list_details] if args.key?(:proximity_location_list_details) + @regional_location_list_details = args[:regional_location_list_details] if args.key?(:regional_location_list_details) + @sensitive_category_exclusion_details = args[:sensitive_category_exclusion_details] if args.key?(:sensitive_category_exclusion_details) + @sub_exchange_details = args[:sub_exchange_details] if args.key?(:sub_exchange_details) + @targeting_type = args[:targeting_type] if args.key?(:targeting_type) + @third_party_verifier_details = args[:third_party_verifier_details] if args.key?(:third_party_verifier_details) + @url_details = args[:url_details] if args.key?(:url_details) + @user_rewarded_content_details = args[:user_rewarded_content_details] if args.key?(:user_rewarded_content_details) + @video_player_size_details = args[:video_player_size_details] if args.key?(:video_player_size_details) + @viewability_details = args[:viewability_details] if args.key?(:viewability_details) + end + end + + # Assigned audience group targeting option details. This will be populated in + # the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_AUDIENCE_GROUP`. + # The relation between each group is UNION, except for + # excluded_first_and_third_party_audience_group and + # excluded_google_audience_group, of which COMPLEMENT is UNION'ed with other + # groups. + class AudienceGroupAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Details of first and third party audience group. + # All first and third party audience targeting settings are logically ‘OR’ of + # each other. + # Corresponds to the JSON property `excludedFirstAndThirdPartyAudienceGroup` + # @return [Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudienceGroup] + attr_accessor :excluded_first_and_third_party_audience_group + + # Details of Google audience group. + # All Google audience targeting settings are logically ‘OR’ of each other. + # Corresponds to the JSON property `excludedGoogleAudienceGroup` + # @return [Google::Apis::DisplayvideoV1::GoogleAudienceGroup] + attr_accessor :excluded_google_audience_group + + # Details of combined audience group. + # All combined audience targeting settings are logically ‘OR’ of each other. + # Corresponds to the JSON property `includedCombinedAudienceGroup` + # @return [Google::Apis::DisplayvideoV1::CombinedAudienceGroup] + attr_accessor :included_combined_audience_group + + # Details of custom list group. + # All custom list targeting settings are logically ‘OR’ of each other. + # Corresponds to the JSON property `includedCustomListGroup` + # @return [Google::Apis::DisplayvideoV1::CustomListGroup] + attr_accessor :included_custom_list_group + + # The first and third party audience ids and recencies of included first + # and third party audience groups. Each first and third party audience group + # contains first and third party audience ids only. + # The relation between each first and third party audience group is + # INTERSECTION, and the result is UNION'ed with other audience groups. + # Repeated groups with same settings will be ignored. + # Corresponds to the JSON property `includedFirstAndThirdPartyAudienceGroups` + # @return [Array] + attr_accessor :included_first_and_third_party_audience_groups + + # Details of Google audience group. + # All Google audience targeting settings are logically ‘OR’ of each other. + # Corresponds to the JSON property `includedGoogleAudienceGroup` + # @return [Google::Apis::DisplayvideoV1::GoogleAudienceGroup] + attr_accessor :included_google_audience_group + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @excluded_first_and_third_party_audience_group = args[:excluded_first_and_third_party_audience_group] if args.key?(:excluded_first_and_third_party_audience_group) + @excluded_google_audience_group = args[:excluded_google_audience_group] if args.key?(:excluded_google_audience_group) + @included_combined_audience_group = args[:included_combined_audience_group] if args.key?(:included_combined_audience_group) + @included_custom_list_group = args[:included_custom_list_group] if args.key?(:included_custom_list_group) + @included_first_and_third_party_audience_groups = args[:included_first_and_third_party_audience_groups] if args.key?(:included_first_and_third_party_audience_groups) + @included_google_audience_group = args[:included_google_audience_group] if args.key?(:included_google_audience_group) + end + end + + # The length an audio or a video has been played. + class AudioVideoOffset + include Google::Apis::Core::Hashable + + # The offset in percentage of the audio or video duration. + # Corresponds to the JSON property `percentage` + # @return [Fixnum] + attr_accessor :percentage + + # The offset in seconds from the start of the audio or video. + # Corresponds to the JSON property `seconds` + # @return [Fixnum] + attr_accessor :seconds + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @percentage = args[:percentage] if args.key?(:percentage) + @seconds = args[:seconds] if args.key?(:seconds) + end + end + + # Represents an assigned authorized seller status. This will be populated in + # the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. + class AuthorizedSellerStatusAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The authorized seller status to target. + # Corresponds to the JSON property `authorizedSellerStatus` + # @return [String] + attr_accessor :authorized_seller_status + + # Required. The targeting_option_id of a + # TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @authorized_seller_status = args[:authorized_seller_status] if args.key?(:authorized_seller_status) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + end + end + + # Represents a targetable authorized seller status. This will be populated in + # the + # authorized_seller_status_details + # field when targeting_type is + # `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. + class AuthorizedSellerStatusTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The authorized seller status. + # Corresponds to the JSON property `authorizedSellerStatus` + # @return [String] + attr_accessor :authorized_seller_status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @authorized_seller_status = args[:authorized_seller_status] if args.key?(:authorized_seller_status) + end + end + + # Settings that control the bid strategy. + # Bid strategy determines the bid price. + class BiddingStrategy + include Google::Apis::Core::Hashable + + # A strategy that uses a fixed bidding price. + # Corresponds to the JSON property `fixedBid` + # @return [Google::Apis::DisplayvideoV1::FixedBidStrategy] + attr_accessor :fixed_bid + + # A strategy that automatically adjusts the bid to optimize a specified + # performance goal while spending the full budget. + # Corresponds to the JSON property `maximizeSpendAutoBid` + # @return [Google::Apis::DisplayvideoV1::MaximizeSpendBidStrategy] + attr_accessor :maximize_spend_auto_bid + + # A strategy that automatically adjusts the bid to meet or beat a specified + # performance goal. + # Corresponds to the JSON property `performanceGoalAutoBid` + # @return [Google::Apis::DisplayvideoV1::PerformanceGoalBidStrategy] + attr_accessor :performance_goal_auto_bid + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @fixed_bid = args[:fixed_bid] if args.key?(:fixed_bid) + @maximize_spend_auto_bid = args[:maximize_spend_auto_bid] if args.key?(:maximize_spend_auto_bid) + @performance_goal_auto_bid = args[:performance_goal_auto_bid] if args.key?(:performance_goal_auto_bid) + end + end + + # Details for assigned browser targeting option. This will be populated in + # the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_BROWSER`. + class BrowserAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The display name of the browser. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Indicates if this option is being negatively targeted. All assigned browser + # targeting options on the same line item must have the same value for this + # field. + # Corresponds to the JSON property `negative` + # @return [Boolean] + attr_accessor :negative + alias_method :negative?, :negative + + # Required. The targeting_option_id of a + # TargetingOption of type `TARGETING_TYPE_BROWSER`. + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + @negative = args[:negative] if args.key?(:negative) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + end + end + + # Represents a targetable browser. This will be populated in the + # browser_details field when + # targeting_type is + # `TARGETING_TYPE_BROWSER`. + class BrowserTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The display name of the browser. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + end + end + + # Request message for + # BulkEditLineItemAssignedTargetingOptions. + class BulkEditLineItemAssignedTargetingOptionsRequest + include Google::Apis::Core::Hashable + + # The assigned targeting options to create in batch, specified as a list of + # `CreateAssignedTargetingOptionsRequest`. + # Corresponds to the JSON property `createRequests` + # @return [Array] + attr_accessor :create_requests + + # The assigned targeting options to delete in batch, specified as a list of + # `DeleteAssignedTargetingOptionsRequest`. + # Corresponds to the JSON property `deleteRequests` + # @return [Array] + attr_accessor :delete_requests + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @create_requests = args[:create_requests] if args.key?(:create_requests) + @delete_requests = args[:delete_requests] if args.key?(:delete_requests) + end + end + + # + class BulkEditLineItemAssignedTargetingOptionsResponse + include Google::Apis::Core::Hashable + + # The list of assigned targeting options that have been successfully created. + # This list will be absent if empty. + # Corresponds to the JSON property `createdAssignedTargetingOptions` + # @return [Array] + attr_accessor :created_assigned_targeting_options + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @created_assigned_targeting_options = args[:created_assigned_targeting_options] if args.key?(:created_assigned_targeting_options) + end + end + + # + class BulkListLineItemAssignedTargetingOptionsResponse + include Google::Apis::Core::Hashable + + # The list of assigned targeting options. + # This list will be absent if empty. + # Corresponds to the JSON property `assignedTargetingOptions` + # @return [Array] + attr_accessor :assigned_targeting_options + + # A token identifying the next page of results. This value should be + # specified as the + # pageToken in + # a subsequent BulkListLineItemAssignedTargetingOptionsRequest to fetch + # the next page of results. This token will be absent if there are no more + # assigned_targeting_options + # to return. + # 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) + @assigned_targeting_options = args[:assigned_targeting_options] if args.key?(:assigned_targeting_options) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # A single campaign. + class Campaign + include Google::Apis::Core::Hashable + + # Output only. The unique ID of the advertiser the campaign belongs to. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Settings that track the planned spend and duration of a campaign. + # Corresponds to the JSON property `campaignFlight` + # @return [Google::Apis::DisplayvideoV1::CampaignFlight] + attr_accessor :campaign_flight + + # Settings that control the goal of a campaign. + # Corresponds to the JSON property `campaignGoal` + # @return [Google::Apis::DisplayvideoV1::CampaignGoal] + attr_accessor :campaign_goal + + # Output only. The unique ID of the campaign. Assigned by the system. + # Corresponds to the JSON property `campaignId` + # @return [Fixnum] + attr_accessor :campaign_id + + # Required. The display name of the campaign. + # Must be UTF-8 encoded with a maximum size of 240 bytes. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Required. Controls whether or not the insertion orders under this campaign + # can spend their budgets and bid on inventory. + # * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and + # `ENTITY_STATUS_PAUSED`. + # * For + # CreateCampaign method, + # `ENTITY_STATUS_ARCHIVED` is not allowed. + # Corresponds to the JSON property `entityStatus` + # @return [String] + attr_accessor :entity_status + + # Settings that control the number of times a user may be shown with the same + # ad during a given time period. + # Corresponds to the JSON property `frequencyCap` + # @return [Google::Apis::DisplayvideoV1::FrequencyCap] + attr_accessor :frequency_cap + + # Output only. The resource name of the campaign. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. The timestamp when the campaign was last updated. Assigned by the + # system. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @campaign_flight = args[:campaign_flight] if args.key?(:campaign_flight) + @campaign_goal = args[:campaign_goal] if args.key?(:campaign_goal) + @campaign_id = args[:campaign_id] if args.key?(:campaign_id) + @display_name = args[:display_name] if args.key?(:display_name) + @entity_status = args[:entity_status] if args.key?(:entity_status) + @frequency_cap = args[:frequency_cap] if args.key?(:frequency_cap) + @name = args[:name] if args.key?(:name) + @update_time = args[:update_time] if args.key?(:update_time) + end + end + + # Settings that track the planned spend and duration of a campaign. + class CampaignFlight + include Google::Apis::Core::Hashable + + # A date range. + # Corresponds to the JSON property `plannedDates` + # @return [Google::Apis::DisplayvideoV1::DateRange] + attr_accessor :planned_dates + + # The amount the campaign is expected to spend for its given + # planned_dates. This will not limit serving, + # but will be used for tracking spend in the DV360 UI. + # The amount is in micros. Must be greater than or equal to 0. For example, + # 500000000 represents 500 standard units of the currency. + # Corresponds to the JSON property `plannedSpendAmountMicros` + # @return [Fixnum] + attr_accessor :planned_spend_amount_micros + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @planned_dates = args[:planned_dates] if args.key?(:planned_dates) + @planned_spend_amount_micros = args[:planned_spend_amount_micros] if args.key?(:planned_spend_amount_micros) + end + end + + # Settings that control the goal of a campaign. + class CampaignGoal + include Google::Apis::Core::Hashable + + # Required. The type of the campaign goal. + # Corresponds to the JSON property `campaignGoalType` + # @return [String] + attr_accessor :campaign_goal_type + + # Settings that control the performance goal of a campaign or insertion order. + # Corresponds to the JSON property `performanceGoal` + # @return [Google::Apis::DisplayvideoV1::PerformanceGoal] + attr_accessor :performance_goal + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @campaign_goal_type = args[:campaign_goal_type] if args.key?(:campaign_goal_type) + @performance_goal = args[:performance_goal] if args.key?(:performance_goal) + end + end + + # Details for assigned carrier and ISP targeting option. This will be populated + # in the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_CARRIER_AND_ISP`. + class CarrierAndIspAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The display name of the carrier or ISP. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Indicates if this option is being negatively targeted. All assigned carrier + # and ISP targeting options on the same line item must have the same value + # for this field. + # Corresponds to the JSON property `negative` + # @return [Boolean] + attr_accessor :negative + alias_method :negative?, :negative + + # Required. The targeting_option_id of a + # TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`. + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + @negative = args[:negative] if args.key?(:negative) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + end + end + + # Represents a targetable carrier or ISP. This will be populated in the + # carrier_and_isp_details field of + # a TargetingOption when + # targeting_type is + # `TARGETING_TYPE_CARRIER_AND_ISP`. + class CarrierAndIspTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The display name of the carrier or ISP. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Output only. The type indicating if it's carrier or ISP. + # 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) + @display_name = args[:display_name] if args.key?(:display_name) + @type = args[:type] if args.key?(:type) + end + end + + # Assigned category targeting option details. This will be populated in the + # category_details field when + # targeting_type is + # `TARGETING_TYPE_CATEGORY`. + class CategoryAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The display name of the category. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Indicates if this option is being negatively targeted. + # Corresponds to the JSON property `negative` + # @return [Boolean] + attr_accessor :negative + alias_method :negative?, :negative + + # Required. The targeting_option_id field when + # targeting_type is + # `TARGETING_TYPE_CATEGORY`. + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + @negative = args[:negative] if args.key?(:negative) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + end + end + + # Represents a targetable category. This will be populated in the + # category_details field of a + # TargetingOption when targeting_type is + # `TARGETING_TYPE_CATEGORY`. + class CategoryTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The display name of the category. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + end + end + + # A single channel. Channels are custom groups of related websites and apps. + class Channel + include Google::Apis::Core::Hashable + + # The ID of the advertiser that owns the channel. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Output only. The unique ID of the channel. Assigned by the system. + # Corresponds to the JSON property `channelId` + # @return [Fixnum] + attr_accessor :channel_id + + # Required. The display name of the channel. + # Must be UTF-8 encoded with a maximum length of 240 bytes. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Output only. The resource name of the channel. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The ID of the partner that owns the channel. + # Corresponds to the JSON property `partnerId` + # @return [Fixnum] + attr_accessor :partner_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @channel_id = args[:channel_id] if args.key?(:channel_id) + @display_name = args[:display_name] if args.key?(:display_name) + @name = args[:name] if args.key?(:name) + @partner_id = args[:partner_id] if args.key?(:partner_id) + end + end + + # Details for assigned channel targeting option. This will be populated in + # the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_CHANNEL`. + class ChannelAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Required. ID of the channel. Should refer to the channel ID + # field on a + # [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or + # [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) + # resource. + # Corresponds to the JSON property `channelId` + # @return [Fixnum] + attr_accessor :channel_id + + # Indicates if this option is being negatively targeted. For advertiser + # level assigned targeting option, this field must be true. + # Corresponds to the JSON property `negative` + # @return [Boolean] + attr_accessor :negative + alias_method :negative?, :negative + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @channel_id = args[:channel_id] if args.key?(:channel_id) + @negative = args[:negative] if args.key?(:negative) + end + end + + # Settings for advertisers that use both Campaign Manager (CM) and third-party + # ad servers. + class CmHybridConfig + include Google::Apis::Core::Hashable + + # Required. Immutable. Account ID of the CM Floodlight configuration linked with + # the DV360 + # advertiser. + # Corresponds to the JSON property `cmAccountId` + # @return [Fixnum] + attr_accessor :cm_account_id + + # Required. Immutable. ID of the CM Floodlight configuration linked with the + # DV360 advertiser. + # Corresponds to the JSON property `cmFloodlightConfigId` + # @return [Fixnum] + attr_accessor :cm_floodlight_config_id + + # Required. Immutable. By setting this field to `true`, you, on behalf of your + # company, + # authorize the sharing of information from the given Floodlight + # configuration to this Display & Video 360 advertiser. + # Corresponds to the JSON property `cmFloodlightLinkingAuthorized` + # @return [Boolean] + attr_accessor :cm_floodlight_linking_authorized + alias_method :cm_floodlight_linking_authorized?, :cm_floodlight_linking_authorized + + # A list of CM sites whose placements will be synced to DV360 as creatives. + # If absent or empty in + # CreateAdvertiser method, the system + # will automatically create a CM site. + # Removing sites from this list may cause DV360 creatives synced from CM to + # be deleted. At least one site must be specified. + # Corresponds to the JSON property `cmSyncableSiteIds` + # @return [Array] + attr_accessor :cm_syncable_site_ids + + # Whether or not to report DV360 cost to CM. + # Corresponds to the JSON property `dv360ToCmCostReportingEnabled` + # @return [Boolean] + attr_accessor :dv360_to_cm_cost_reporting_enabled + alias_method :dv360_to_cm_cost_reporting_enabled?, :dv360_to_cm_cost_reporting_enabled + + # Whether or not to include DV360 data in CM data transfer reports. + # Corresponds to the JSON property `dv360ToCmDataSharingEnabled` + # @return [Boolean] + attr_accessor :dv360_to_cm_data_sharing_enabled + alias_method :dv360_to_cm_data_sharing_enabled?, :dv360_to_cm_data_sharing_enabled + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cm_account_id = args[:cm_account_id] if args.key?(:cm_account_id) + @cm_floodlight_config_id = args[:cm_floodlight_config_id] if args.key?(:cm_floodlight_config_id) + @cm_floodlight_linking_authorized = args[:cm_floodlight_linking_authorized] if args.key?(:cm_floodlight_linking_authorized) + @cm_syncable_site_ids = args[:cm_syncable_site_ids] if args.key?(:cm_syncable_site_ids) + @dv360_to_cm_cost_reporting_enabled = args[:dv360_to_cm_cost_reporting_enabled] if args.key?(:dv360_to_cm_cost_reporting_enabled) + @dv360_to_cm_data_sharing_enabled = args[:dv360_to_cm_data_sharing_enabled] if args.key?(:dv360_to_cm_data_sharing_enabled) + end + end + + # A Campaign Manager tracking ad. + class CmTrackingAd + include Google::Apis::Core::Hashable + + # The ad ID of the campaign manager tracking Ad. + # Corresponds to the JSON property `cmAdId` + # @return [Fixnum] + attr_accessor :cm_ad_id + + # The creative ID of the campaign manager tracking Ad. + # Corresponds to the JSON property `cmCreativeId` + # @return [Fixnum] + attr_accessor :cm_creative_id + + # The placement ID of the campaign manager tracking Ad. + # Corresponds to the JSON property `cmPlacementId` + # @return [Fixnum] + attr_accessor :cm_placement_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cm_ad_id = args[:cm_ad_id] if args.key?(:cm_ad_id) + @cm_creative_id = args[:cm_creative_id] if args.key?(:cm_creative_id) + @cm_placement_id = args[:cm_placement_id] if args.key?(:cm_placement_id) + end + end + + # Describes a combined audience resource. + class CombinedAudience + include Google::Apis::Core::Hashable + + # Output only. The unique ID of the combined audience. Assigned by the system. + # Corresponds to the JSON property `combinedAudienceId` + # @return [Fixnum] + attr_accessor :combined_audience_id + + # Output only. The display name of the combined audience. + # . + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Output only. The resource name of the combined audience. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @combined_audience_id = args[:combined_audience_id] if args.key?(:combined_audience_id) + @display_name = args[:display_name] if args.key?(:display_name) + @name = args[:name] if args.key?(:name) + end + end + + # Details of combined audience group. + # All combined audience targeting settings are logically ‘OR’ of each other. + class CombinedAudienceGroup + include Google::Apis::Core::Hashable + + # Required. All combined audience targeting settings in combined audience group. + # Repeated settings with same id will be ignored. + # The number of combined audience settings should be no more than five, error + # will be thrown otherwise. + # Corresponds to the JSON property `settings` + # @return [Array] + attr_accessor :settings + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @settings = args[:settings] if args.key?(:settings) + end + end + + # Details of combined audience targeting setting. + class CombinedAudienceTargetingSetting + include Google::Apis::Core::Hashable + + # Required. Combined audience id of combined audience targeting setting. + # This id is combined_audience_id. + # Corresponds to the JSON property `combinedAudienceId` + # @return [Fixnum] + attr_accessor :combined_audience_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @combined_audience_id = args[:combined_audience_id] if args.key?(:combined_audience_id) + end + end + + # Assigned content instream position targeting option details. This will be + # populated in the + # content_instream_position_details + # field when + # targeting_type is + # `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. + class ContentInstreamPositionAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The content instream position for video or audio ads. + # Corresponds to the JSON property `contentInstreamPosition` + # @return [String] + attr_accessor :content_instream_position + + # Required. The targeting_option_id field when + # targeting_type is + # `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content_instream_position = args[:content_instream_position] if args.key?(:content_instream_position) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + end + end + + # Represents a targetable content instream position, which could be used by + # video and audio ads. This will be populated in the + # content_instream_position_details + # field when targeting_type is + # `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. + class ContentInstreamPositionTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The content instream position. + # Corresponds to the JSON property `contentInstreamPosition` + # @return [String] + attr_accessor :content_instream_position + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content_instream_position = args[:content_instream_position] if args.key?(:content_instream_position) + end + end + + # Assigned content outstream position targeting option details. This will be + # populated in the + # content_outstream_position_details + # field when + # targeting_type is + # `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. + class ContentOutstreamPositionAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The content outstream position. + # Corresponds to the JSON property `contentOutstreamPosition` + # @return [String] + attr_accessor :content_outstream_position + + # Required. The targeting_option_id field when + # targeting_type is + # `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content_outstream_position = args[:content_outstream_position] if args.key?(:content_outstream_position) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + end + end + + # Represents a targetable content outstream position, which could be used by + # display and video ads. This will be populated in the + # content_outstream_position_details + # field when targeting_type is + # `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. + class ContentOutstreamPositionTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The content outstream position. + # Corresponds to the JSON property `contentOutstreamPosition` + # @return [String] + attr_accessor :content_outstream_position + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content_outstream_position = args[:content_outstream_position] if args.key?(:content_outstream_position) + end + end + + # Settings that control how conversions are counted. + # All post-click conversions will be counted. A percentage value can be set + # for post-view conversions counting. + class ConversionCountingConfig + include Google::Apis::Core::Hashable + + # The Floodlight activity configs used to track conversions. + # The number of conversions counted is the sum of all of the conversions + # counted by all of the Floodlight activity IDs specified in this field. + # Corresponds to the JSON property `floodlightActivityConfigs` + # @return [Array] + attr_accessor :floodlight_activity_configs + + # The percentage of post-view conversions to count, in millis (1/1000 of a + # percent). Must be between 0 and 100000 inclusive. + # For example, to track 50% of the post-click conversions, set a value of + # 50000. + # Corresponds to the JSON property `postViewCountPercentageMillis` + # @return [Fixnum] + attr_accessor :post_view_count_percentage_millis + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @floodlight_activity_configs = args[:floodlight_activity_configs] if args.key?(:floodlight_activity_configs) + @post_view_count_percentage_millis = args[:post_view_count_percentage_millis] if args.key?(:post_view_count_percentage_millis) + end + end + + # Counter event of the creative. + class CounterEvent + include Google::Apis::Core::Hashable + + # Required. The name of the counter event. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Required. The name used to identify this counter event in reports. + # Corresponds to the JSON property `reportingName` + # @return [String] + attr_accessor :reporting_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @reporting_name = args[:reporting_name] if args.key?(:reporting_name) + end + end + + # A request message for CreateAsset. + class CreateAssetRequest + include Google::Apis::Core::Hashable + + # Required. The filename of the asset, including the file extension. + # The filename must be UTF-8 encoded with a maximum size of 240 bytes. + # Corresponds to the JSON property `filename` + # @return [String] + attr_accessor :filename + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @filename = args[:filename] if args.key?(:filename) + end + end + + # A response message for CreateAsset. + class CreateAssetResponse + include Google::Apis::Core::Hashable + + # A single asset. + # Corresponds to the JSON property `asset` + # @return [Google::Apis::DisplayvideoV1::Asset] + attr_accessor :asset + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @asset = args[:asset] if args.key?(:asset) + end + end + + # A request listing which assigned targeting options of a given targeting type + # should be created and added. + class CreateAssignedTargetingOptionsRequest + include Google::Apis::Core::Hashable + + # Required. The assigned targeting options to create and add. + # Corresponds to the JSON property `assignedTargetingOptions` + # @return [Array] + attr_accessor :assigned_targeting_options + + # Required. Identifies the type of this assigned targeting option. + # Corresponds to the JSON property `targetingType` + # @return [String] + attr_accessor :targeting_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @assigned_targeting_options = args[:assigned_targeting_options] if args.key?(:assigned_targeting_options) + @targeting_type = args[:targeting_type] if args.key?(:targeting_type) + end + end + # Request message for [SdfDownloadTaskService.CreateSdfDownloadTask]. class CreateSdfDownloadTaskRequest include Google::Apis::Core::Hashable @@ -75,6 +2108,1757 @@ module Google end end + # A single Creative. + class Creative + include Google::Apis::Core::Hashable + + # Additional dimensions. + # Applicable when creative_type is one of: + # * `CREATIVE_TYPE_STANDARD` + # * `CREATIVE_TYPE_EXPANDABLE` + # * `CREATIVE_TYPE_NATIVE` + # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL` + # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` + # * `CREATIVE_TYPE_LIGHTBOX` + # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` + # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` + # * `CREATIVE_TYPE_PUBLISHER_HOSTED` + # If this field is specified, width_pixels and + # height_pixels are both required and must be + # greater than or equal to 0. + # Corresponds to the JSON property `additionalDimensions` + # @return [Array] + attr_accessor :additional_dimensions + + # Output only. The unique ID of the advertiser the creative belongs to. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Third-party HTML tracking tag to be appended to the creative tag. + # Corresponds to the JSON property `appendedTag` + # @return [String] + attr_accessor :appended_tag + + # Required. Assets associated to this creative. + # Assets can be associated to the creative in one of following roles: + # * `ASSET_ROLE_UNSPECIFIED` + # * `ASSET_ROLE_MAIN` + # * `ASSET_ROLE_BACKUP` + # * `ASSET_ROLE_POLITE_LOAD` + # Corresponds to the JSON property `assets` + # @return [Array] + attr_accessor :assets + + # Output only. The unique ID of the Campaign Manager placement associated with + # the + # creative. + # This field is only applicable for creatives that are synced from Campaign + # Manager. + # Corresponds to the JSON property `cmPlacementId` + # @return [Fixnum] + attr_accessor :cm_placement_id + + # A Campaign Manager tracking ad. + # Corresponds to the JSON property `cmTrackingAd` + # @return [Google::Apis::DisplayvideoV1::CmTrackingAd] + attr_accessor :cm_tracking_ad + + # The IDs of companion creatives for a video creative. + # You can assign existing display creatives (with image or HTML5 assets) + # to serve surrounding the publisher's video player. Companions display + # around the video player while the video is playing and remain after the + # video has completed. + # Creatives contain additional dimensions + # can not be companion creatives. + # This field is only supported for following + # creative_type: + # * `CREATIVE_TYPE_AUDIO` + # * `CREATIVE_TYPE_VIDEO` + # Corresponds to the JSON property `companionCreativeIds` + # @return [Array] + attr_accessor :companion_creative_ids + + # Counter events for a rich media creative. + # Counters track the number of times that a user interacts with any part of a + # rich media creative in a specified way (mouse-overs, mouse-outs, clicks, + # taps, data loading, keyboard entries, etc.). + # Any event that can be captured in the creative can be recorded as a + # counter. + # Leave it empty or unset for creatives containing image assets only. + # Corresponds to the JSON property `counterEvents` + # @return [Array] + attr_accessor :counter_events + + # Output only. The timestamp when the creative was created. Assigned by + # the system. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Output only. A list of attributes of the creative that is generated by the + # system. + # Corresponds to the JSON property `creativeAttributes` + # @return [Array] + attr_accessor :creative_attributes + + # Output only. The unique ID of the creative. Assigned by the system. + # Corresponds to the JSON property `creativeId` + # @return [Fixnum] + attr_accessor :creative_id + + # Required. Immutable. The type of the creative. + # Corresponds to the JSON property `creativeType` + # @return [String] + attr_accessor :creative_type + + # Dimensions. + # Corresponds to the JSON property `dimensions` + # @return [Google::Apis::DisplayvideoV1::Dimensions] + attr_accessor :dimensions + + # Required. The display name of the creative. + # Must be UTF-8 encoded with a maximum size of 240 bytes. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Output only. Indicates whether the creative is dynamic. + # Corresponds to the JSON property `dynamic` + # @return [Boolean] + attr_accessor :dynamic + alias_method :dynamic?, :dynamic + + # Required. Controls whether or not the creative can serve. + # Accepted values are: + # * `ENTITY_STATUS_ACTIVE` + # * `ENTITY_STATUS_ARCHIVED` + # * `ENTITY_STATUS_PAUSED` + # Corresponds to the JSON property `entityStatus` + # @return [String] + attr_accessor :entity_status + + # Required. Exit events for this creative. + # An exit (also known as a click tag) is any area in your creative that + # someone can click or tap to open an advertiser's landing page. + # Every creative must include at least one exit. + # You can add an exit to your creative in any of the following ways: + # * Use Google Web Designer's tap area. + # * Define a JavaScript variable called "clickTag". + # * Use the Enabler (Enabler.exit()) to track exits in rich media formats. + # Corresponds to the JSON property `exitEvents` + # @return [Array] + attr_accessor :exit_events + + # Optional. Indicates the creative will automatically expand on hover. + # Optional and only valid for third-party expandable creatives. + # Third-party expandable creatives are creatives with following hosting + # source: + # * `HOSTING_SOURCE_THIRD_PARTY` + # combined with following creative_type: + # * `CREATIVE_TYPE_EXPANDABLE` + # Corresponds to the JSON property `expandOnHover` + # @return [Boolean] + attr_accessor :expand_on_hover + alias_method :expand_on_hover?, :expand_on_hover + + # Optional. Specifies the expanding direction of the creative. + # Required and only valid for third-party expandable creatives. + # Third-party expandable creatives are creatives with following hosting + # source: + # * `HOSTING_SOURCE_THIRD_PARTY` + # combined with following creative_type: + # * `CREATIVE_TYPE_EXPANDABLE` + # Corresponds to the JSON property `expandingDirection` + # @return [String] + attr_accessor :expanding_direction + + # Required. Indicates where the creative is hosted. + # Corresponds to the JSON property `hostingSource` + # @return [String] + attr_accessor :hosting_source + + # Output only. Indicates the third-party VAST tag creative requires HTML5 Video + # support. + # Output only and only valid for third-party VAST tag creatives. + # Third-party VAST tag creatives are creatives with following + # hosting_source: + # * `HOSTING_SOURCE_THIRD_PARTY` + # combined with following creative_type: + # * `CREATIVE_TYPE_VIDEO` + # Corresponds to the JSON property `html5Video` + # @return [Boolean] + attr_accessor :html5_video + alias_method :html5_video?, :html5_video + + # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. + # To enable this for the creative, make sure the + # Advertiser.creative_config.ias_client_id + # has been set to your IAS client ID. + # Corresponds to the JSON property `iasCampaignMonitoring` + # @return [Boolean] + attr_accessor :ias_campaign_monitoring + alias_method :ias_campaign_monitoring?, :ias_campaign_monitoring + + # ID information used to link this creative to an external system. + # Must be UTF-8 encoded with a length of no more than 10,000 characters. + # Corresponds to the JSON property `integrationCode` + # @return [String] + attr_accessor :integration_code + + # JavaScript measurement URL from supported third-party verification + # providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not + # supported. + # This field is only supported in following + # creative_type: + # * `CREATIVE_TYPE_NATIVE` + # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` + # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` + # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` + # * `CREATIVE_TYPE_NATIVE_VIDEO` + # Corresponds to the JSON property `jsTrackerUrl` + # @return [String] + attr_accessor :js_tracker_url + + # Output only. Media duration of the creative. + # Applicable when creative_type + # is one of: + # * `CREATIVE_TYPE_VIDEO` + # * `CREATIVE_TYPE_AUDIO` + # * `CREATIVE_TYPE_NATIVE_VIDEO` + # * `CREATIVE_TYPE_PUBLISHER_HOSTED` + # Corresponds to the JSON property `mediaDuration` + # @return [String] + attr_accessor :media_duration + + # Output only. The resource name of the creative. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # User notes for this creative. + # Must be UTF-8 encoded with a length of no more than 20,000 characters. + # Corresponds to the JSON property `notes` + # @return [String] + attr_accessor :notes + + # OBA Icon for a Creative + # Corresponds to the JSON property `obaIcon` + # @return [Google::Apis::DisplayvideoV1::ObaIcon] + attr_accessor :oba_icon + + # The length an audio or a video has been played. + # Corresponds to the JSON property `progressOffset` + # @return [Google::Apis::DisplayvideoV1::AudioVideoOffset] + attr_accessor :progress_offset + + # Optional. Indicates that the creative relies on HTML5 to render properly. + # Optional and only valid for third-party tag creatives. + # Third-party tag creatives are creatives with following + # hosting_source: + # * `HOSTING_SOURCE_THIRD_PARTY` + # combined with following creative_type: + # * `CREATIVE_TYPE_STANDARD` + # * `CREATIVE_TYPE_EXPANDABLE` + # Corresponds to the JSON property `requireHtml5` + # @return [Boolean] + attr_accessor :require_html5 + alias_method :require_html5?, :require_html5 + + # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad + # Interface + # Definitions system). + # Set this if the creative relies on mobile gestures for interactivity, such + # as swiping or tapping. + # Optional and only valid for third-party tag creatives. + # Third-party tag creatives are creatives with following + # hosting_source: + # * `HOSTING_SOURCE_THIRD_PARTY` + # combined with following creative_type: + # * `CREATIVE_TYPE_STANDARD` + # * `CREATIVE_TYPE_EXPANDABLE` + # Corresponds to the JSON property `requireMraid` + # @return [Boolean] + attr_accessor :require_mraid + alias_method :require_mraid?, :require_mraid + + # Optional. Indicates that the creative will wait for a return ping for + # attribution. + # Only valid when using a Campaign Manager tracking ad with a third-party ad + # server parameter and the $`DC_DBM_TOKEN` macro. + # Optional and only valid for third-party tag creatives or third-party VAST + # tag creatives. + # Third-party tag creatives are creatives with following + # hosting_source: + # * `HOSTING_SOURCE_THIRD_PARTY` + # combined with following creative_type: + # * `CREATIVE_TYPE_STANDARD` + # * `CREATIVE_TYPE_EXPANDABLE` + # Third-party VAST tag creatives are creatives with following + # hosting_source: + # * `HOSTING_SOURCE_THIRD_PARTY` + # combined with following creative_type: + # * `CREATIVE_TYPE_VIDEO` + # Corresponds to the JSON property `requirePingForAttribution` + # @return [Boolean] + attr_accessor :require_ping_for_attribution + alias_method :require_ping_for_attribution?, :require_ping_for_attribution + + # Review statuses for the creative. + # Corresponds to the JSON property `reviewStatus` + # @return [Google::Apis::DisplayvideoV1::ReviewStatusInfo] + attr_accessor :review_status + + # The length an audio or a video has been played. + # Corresponds to the JSON property `skipOffset` + # @return [Google::Apis::DisplayvideoV1::AudioVideoOffset] + attr_accessor :skip_offset + + # Whether the user can choose to skip a video creative. + # This field is only supported for the following + # creative_type: + # * `CREATIVE_TYPE_VIDEO` + # Corresponds to the JSON property `skippable` + # @return [Boolean] + attr_accessor :skippable + alias_method :skippable?, :skippable + + # Optional. The original third-party tag used for the creative. + # Required and only valid for third-party tag creatives. + # Third-party tag creatives are creatives with following + # hosting_source: + # * `HOSTING_SOURCE_THIRD_PARTY` + # combined with following creative_type: + # * `CREATIVE_TYPE_STANDARD` + # * `CREATIVE_TYPE_EXPANDABLE` + # Corresponds to the JSON property `thirdPartyTag` + # @return [String] + attr_accessor :third_party_tag + + # Tracking URLs from third parties to track interactions with a video + # creative. + # This field is only supported for the following + # creative_type: + # * `CREATIVE_TYPE_AUDIO` + # * `CREATIVE_TYPE_VIDEO` + # * `CREATIVE_TYPE_NATIVE_VIDEO` + # Corresponds to the JSON property `thirdPartyUrls` + # @return [Array] + attr_accessor :third_party_urls + + # Timer custom events for a rich media creative. + # Timers track the time during which a user views and interacts with a + # specified part of a rich media creative. + # A creative can have multiple timer events, each timed independently. + # Leave it empty or unset for creatives containing image assets only. + # Corresponds to the JSON property `timerEvents` + # @return [Array] + attr_accessor :timer_events + + # Tracking URLs for analytics providers or third-party ad technology vendors. + # The URLs must start with https (except on inventory that doesn't require + # SSL compliance). + # If using macros in your URL, use only macros supported by Display & Video + # 360. + # Standard URLs only, no IMG or SCRIPT tags. + # This field is only supported in following + # creative_type: + # * `CREATIVE_TYPE_NATIVE` + # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` + # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` + # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` + # * `CREATIVE_TYPE_NATIVE_VIDEO` + # Corresponds to the JSON property `trackerUrls` + # @return [Array] + attr_accessor :tracker_urls + + # Output only. Audio/Video transcodes. + # Display & Video 360 transcodes the main asset into a number of alternative + # versions that use different file formats or have different properties + # (resolution, audio bit rate, and video bit rate), each designed for + # specific video players or bandwidths. + # These transcodes give a publisher's system more options to choose from for + # each impression on your video and ensures that the appropriate file serves + # based on the viewer’s connection and screen size. + # This field is only supported in following + # creative_type: + # * `CREATIVE_TYPE_VIDEO` + # * `CREATIVE_TYPE_NATIVE_VIDEO` + # * `CREATIVE_TYPE_AUDIO` + # Corresponds to the JSON property `transcodes` + # @return [Array] + attr_accessor :transcodes + + # A creative identifier provided by a registry that is unique across all + # platforms. This is part of the VAST 4.0 standard. + # Corresponds to the JSON property `universalAdId` + # @return [Google::Apis::DisplayvideoV1::UniversalAdId] + attr_accessor :universal_ad_id + + # Output only. The timestamp when the creative was last updated. Assigned by + # the system. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + + # Optional. The URL of the VAST tag for a third-party VAST tag creative. + # Required and only valid for third-party VAST tag creatives. + # Third-party VAST tag creatives are creatives with following + # hosting_source: + # * `HOSTING_SOURCE_THIRD_PARTY` + # combined with following creative_type: + # * `CREATIVE_TYPE_VIDEO` + # Corresponds to the JSON property `vastTagUrl` + # @return [String] + attr_accessor :vast_tag_url + + # Output only. Indicates the third-party VAST tag creative requires VPAID ( + # Digital Video + # Player-Ad Interface). + # Output only and only valid for third-party VAST tag creatives. + # Third-party VAST tag creatives are creatives with following + # hosting_source: + # * `HOSTING_SOURCE_THIRD_PARTY` + # combined with following creative_type: + # * `CREATIVE_TYPE_VIDEO` + # Corresponds to the JSON property `vpaid` + # @return [Boolean] + attr_accessor :vpaid + alias_method :vpaid?, :vpaid + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @additional_dimensions = args[:additional_dimensions] if args.key?(:additional_dimensions) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @appended_tag = args[:appended_tag] if args.key?(:appended_tag) + @assets = args[:assets] if args.key?(:assets) + @cm_placement_id = args[:cm_placement_id] if args.key?(:cm_placement_id) + @cm_tracking_ad = args[:cm_tracking_ad] if args.key?(:cm_tracking_ad) + @companion_creative_ids = args[:companion_creative_ids] if args.key?(:companion_creative_ids) + @counter_events = args[:counter_events] if args.key?(:counter_events) + @create_time = args[:create_time] if args.key?(:create_time) + @creative_attributes = args[:creative_attributes] if args.key?(:creative_attributes) + @creative_id = args[:creative_id] if args.key?(:creative_id) + @creative_type = args[:creative_type] if args.key?(:creative_type) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @display_name = args[:display_name] if args.key?(:display_name) + @dynamic = args[:dynamic] if args.key?(:dynamic) + @entity_status = args[:entity_status] if args.key?(:entity_status) + @exit_events = args[:exit_events] if args.key?(:exit_events) + @expand_on_hover = args[:expand_on_hover] if args.key?(:expand_on_hover) + @expanding_direction = args[:expanding_direction] if args.key?(:expanding_direction) + @hosting_source = args[:hosting_source] if args.key?(:hosting_source) + @html5_video = args[:html5_video] if args.key?(:html5_video) + @ias_campaign_monitoring = args[:ias_campaign_monitoring] if args.key?(:ias_campaign_monitoring) + @integration_code = args[:integration_code] if args.key?(:integration_code) + @js_tracker_url = args[:js_tracker_url] if args.key?(:js_tracker_url) + @media_duration = args[:media_duration] if args.key?(:media_duration) + @name = args[:name] if args.key?(:name) + @notes = args[:notes] if args.key?(:notes) + @oba_icon = args[:oba_icon] if args.key?(:oba_icon) + @progress_offset = args[:progress_offset] if args.key?(:progress_offset) + @require_html5 = args[:require_html5] if args.key?(:require_html5) + @require_mraid = args[:require_mraid] if args.key?(:require_mraid) + @require_ping_for_attribution = args[:require_ping_for_attribution] if args.key?(:require_ping_for_attribution) + @review_status = args[:review_status] if args.key?(:review_status) + @skip_offset = args[:skip_offset] if args.key?(:skip_offset) + @skippable = args[:skippable] if args.key?(:skippable) + @third_party_tag = args[:third_party_tag] if args.key?(:third_party_tag) + @third_party_urls = args[:third_party_urls] if args.key?(:third_party_urls) + @timer_events = args[:timer_events] if args.key?(:timer_events) + @tracker_urls = args[:tracker_urls] if args.key?(:tracker_urls) + @transcodes = args[:transcodes] if args.key?(:transcodes) + @universal_ad_id = args[:universal_ad_id] if args.key?(:universal_ad_id) + @update_time = args[:update_time] if args.key?(:update_time) + @vast_tag_url = args[:vast_tag_url] if args.key?(:vast_tag_url) + @vpaid = args[:vpaid] if args.key?(:vpaid) + end + end + + # Creative requirements configuration for the inventory source. + class CreativeConfig + include Google::Apis::Core::Hashable + + # The type of creative that can be assigned to the inventory source. + # Corresponds to the JSON property `creativeType` + # @return [String] + attr_accessor :creative_type + + # The configuration for display creatives. + # Corresponds to the JSON property `displayCreativeConfig` + # @return [Google::Apis::DisplayvideoV1::InventorySourceDisplayCreativeConfig] + attr_accessor :display_creative_config + + # The configuration for video creatives. + # Corresponds to the JSON property `videoCreativeConfig` + # @return [Google::Apis::DisplayvideoV1::InventorySourceVideoCreativeConfig] + attr_accessor :video_creative_config + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @creative_type = args[:creative_type] if args.key?(:creative_type) + @display_creative_config = args[:display_creative_config] if args.key?(:display_creative_config) + @video_creative_config = args[:video_creative_config] if args.key?(:video_creative_config) + end + end + + # Describes a custom list entity, such as a custom affinity or custom intent + # audience list. + class CustomList + include Google::Apis::Core::Hashable + + # Output only. The unique ID of the custom list. Assigned by the system. + # Corresponds to the JSON property `customListId` + # @return [Fixnum] + attr_accessor :custom_list_id + + # Output only. The display name of the custom list. + # . + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Output only. The resource name of the custom list. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @custom_list_id = args[:custom_list_id] if args.key?(:custom_list_id) + @display_name = args[:display_name] if args.key?(:display_name) + @name = args[:name] if args.key?(:name) + end + end + + # Details of custom list group. + # All custom list targeting settings are logically ‘OR’ of each other. + class CustomListGroup + include Google::Apis::Core::Hashable + + # Required. All custom list targeting settings in custom list group. + # Repeated settings with same id will be ignored. + # Corresponds to the JSON property `settings` + # @return [Array] + attr_accessor :settings + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @settings = args[:settings] if args.key?(:settings) + end + end + + # Details of custom list targeting setting. + class CustomListTargetingSetting + include Google::Apis::Core::Hashable + + # Required. Custom id of custom list targeting setting. + # This id is custom_list_id. + # Corresponds to the JSON property `customListId` + # @return [Fixnum] + attr_accessor :custom_list_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @custom_list_id = args[:custom_list_id] if args.key?(:custom_list_id) + end + end + + # Represents a whole or partial calendar date, e.g. a birthday. The time of day + # and time zone are either specified elsewhere or are not significant. The date + # is relative to the Proleptic Gregorian Calendar. This can represent: + # * A full date, with non-zero year, month and day values + # * A month and day value, with a zero year, e.g. an anniversary + # * A year on its own, with zero month and day values + # * A year and month value, with a zero day, e.g. a credit card expiration date + # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. + class Date + include Google::Apis::Core::Hashable + + # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 + # if specifying a year by itself or a year and month where the day is not + # significant. + # Corresponds to the JSON property `day` + # @return [Fixnum] + attr_accessor :day + + # Month of year. Must be from 1 to 12, or 0 if specifying a year without a + # month and day. + # Corresponds to the JSON property `month` + # @return [Fixnum] + attr_accessor :month + + # Year of date. Must be from 1 to 9999, or 0 if specifying a date without + # a year. + # Corresponds to the JSON property `year` + # @return [Fixnum] + attr_accessor :year + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @day = args[:day] if args.key?(:day) + @month = args[:month] if args.key?(:month) + @year = args[:year] if args.key?(:year) + end + end + + # A date range. + class DateRange + include Google::Apis::Core::Hashable + + # Represents a whole or partial calendar date, e.g. a birthday. The time of day + # and time zone are either specified elsewhere or are not significant. The date + # is relative to the Proleptic Gregorian Calendar. This can represent: + # * A full date, with non-zero year, month and day values + # * A month and day value, with a zero year, e.g. an anniversary + # * A year on its own, with zero month and day values + # * A year and month value, with a zero day, e.g. a credit card expiration date + # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. + # Corresponds to the JSON property `endDate` + # @return [Google::Apis::DisplayvideoV1::Date] + attr_accessor :end_date + + # Represents a whole or partial calendar date, e.g. a birthday. The time of day + # and time zone are either specified elsewhere or are not significant. The date + # is relative to the Proleptic Gregorian Calendar. This can represent: + # * A full date, with non-zero year, month and day values + # * A month and day value, with a zero year, e.g. an anniversary + # * A year on its own, with zero month and day values + # * A year and month value, with a zero day, e.g. a credit card expiration date + # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. + # Corresponds to the JSON property `startDate` + # @return [Google::Apis::DisplayvideoV1::Date] + attr_accessor :start_date + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end_date = args[:end_date] if args.key?(:end_date) + @start_date = args[:start_date] if args.key?(:start_date) + end + end + + # Representation of a segment of time defined on a specific day of the week and + # with a start and end time. + # The time represented by `start_hour` must be before the time represented by + # `end_hour`. + class DayAndTimeAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Required. The day of the week for this day and time targeting setting. + # Corresponds to the JSON property `dayOfWeek` + # @return [String] + attr_accessor :day_of_week + + # Required. The end hour for day and time targeting. Must be between 1 (1 hour + # after + # start of day) and 24 (end of day). + # Corresponds to the JSON property `endHour` + # @return [Fixnum] + attr_accessor :end_hour + + # Required. The start hour for day and time targeting. Must be between 0 (start + # of day) + # and 23 (1 hour before end of day). + # Corresponds to the JSON property `startHour` + # @return [Fixnum] + attr_accessor :start_hour + + # Required. The mechanism used to determine which timezone to use for this day + # and time + # targeting setting. + # Corresponds to the JSON property `timeZoneResolution` + # @return [String] + attr_accessor :time_zone_resolution + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @day_of_week = args[:day_of_week] if args.key?(:day_of_week) + @end_hour = args[:end_hour] if args.key?(:end_hour) + @start_hour = args[:start_hour] if args.key?(:start_hour) + @time_zone_resolution = args[:time_zone_resolution] if args.key?(:time_zone_resolution) + end + end + + # A request listing which assigned targeting options of a given targeting type + # should be deleted. + class DeleteAssignedTargetingOptionsRequest + include Google::Apis::Core::Hashable + + # Required. The assigned targeting option IDs to delete. + # Corresponds to the JSON property `assignedTargetingOptionIds` + # @return [Array] + attr_accessor :assigned_targeting_option_ids + + # Required. Identifies the type of this assigned targeting option. + # Corresponds to the JSON property `targetingType` + # @return [String] + attr_accessor :targeting_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @assigned_targeting_option_ids = args[:assigned_targeting_option_ids] if args.key?(:assigned_targeting_option_ids) + @targeting_type = args[:targeting_type] if args.key?(:targeting_type) + end + end + + # Assigned device make and model targeting option details. This will be + # populated in the + # device_make_model_details + # field when + # targeting_type is + # `TARGETING_TYPE_DEVICE_MAKE_MODEL`. + class DeviceMakeModelAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The display name of the device make and model. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Indicates if this option is being negatively targeted. + # Corresponds to the JSON property `negative` + # @return [Boolean] + attr_accessor :negative + alias_method :negative?, :negative + + # Required. The targeting_option_id field when + # targeting_type is + # `TARGETING_TYPE_DEVICE_MAKE_MODEL`. + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + @negative = args[:negative] if args.key?(:negative) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + end + end + + # Represents a targetable device make and model. This will be populated in the + # device_make_model_details + # field of a TargetingOption when + # targeting_type is + # `TARGETING_TYPE_DEVICE_MAKE_MODEL`. + class DeviceMakeModelTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The display name of the device make and model. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + end + end + + # Targeting details for device type. This will be + # populated in the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_DEVICE_TYPE`. + class DeviceTypeAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The display name of the device type. + # Corresponds to the JSON property `deviceType` + # @return [String] + attr_accessor :device_type + + # Required. ID of the device type. + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @device_type = args[:device_type] if args.key?(:device_type) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + end + end + + # Represents a targetable device type. This will be populated in the + # device_type_details field of a + # TargetingOption when targeting_type is + # `TARGETING_TYPE_DEVICE_TYPE`. + class DeviceTypeTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The device type that is used to be targeted. + # Corresponds to the JSON property `deviceType` + # @return [String] + attr_accessor :device_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @device_type = args[:device_type] if args.key?(:device_type) + end + end + + # Targeting details for digital content label. This will be + # populated in the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. + class DigitalContentLabelAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The display name of the digital content label rating tier. + # Corresponds to the JSON property `contentRatingTier` + # @return [String] + attr_accessor :content_rating_tier + + # Required. ID of the digital content label to be EXCLUDED. + # Corresponds to the JSON property `excludedTargetingOptionId` + # @return [String] + attr_accessor :excluded_targeting_option_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content_rating_tier = args[:content_rating_tier] if args.key?(:content_rating_tier) + @excluded_targeting_option_id = args[:excluded_targeting_option_id] if args.key?(:excluded_targeting_option_id) + end + end + + # Represents a targetable digital content label rating tier. This will be + # populated in the + # digital_content_label_details + # field of the TargetingOption when + # targeting_type is + # `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. + class DigitalContentLabelTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. An enum for the content label brand safety tiers. + # Corresponds to the JSON property `contentRatingTier` + # @return [String] + attr_accessor :content_rating_tier + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content_rating_tier = args[:content_rating_tier] if args.key?(:content_rating_tier) + end + end + + # Dimensions. + class Dimensions + include Google::Apis::Core::Hashable + + # The height in pixels. + # Corresponds to the JSON property `heightPixels` + # @return [Fixnum] + attr_accessor :height_pixels + + # The width in pixels. + # Corresponds to the JSON property `widthPixels` + # @return [Fixnum] + attr_accessor :width_pixels + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @height_pixels = args[:height_pixels] if args.key?(:height_pixels) + @width_pixels = args[:width_pixels] if args.key?(:width_pixels) + end + end + + # Details of DoubleVerify settings. + class DoubleVerify + include Google::Apis::Core::Hashable + + # Details of DoubleVerify star ratings settings. + # Corresponds to the JSON property `appStarRating` + # @return [Google::Apis::DisplayvideoV1::DoubleVerifyAppStarRating] + attr_accessor :app_star_rating + + # Avoid bidding on apps with the age rating. + # Corresponds to the JSON property `avoidedAgeRatings` + # @return [Array] + attr_accessor :avoided_age_ratings + + # Settings for brand safety controls. + # Corresponds to the JSON property `brandSafetyCategories` + # @return [Google::Apis::DisplayvideoV1::DoubleVerifyBrandSafetyCategories] + attr_accessor :brand_safety_categories + + # Details of DoubleVerify display viewability settings. + # Corresponds to the JSON property `displayViewability` + # @return [Google::Apis::DisplayvideoV1::DoubleVerifyDisplayViewability] + attr_accessor :display_viewability + + # DoubleVerify Fraud & Invalid Traffic settings. + # Corresponds to the JSON property `fraudInvalidTraffic` + # @return [Google::Apis::DisplayvideoV1::DoubleVerifyFraudInvalidTraffic] + attr_accessor :fraud_invalid_traffic + + # Details of DoubleVerify video viewability settings. + # Corresponds to the JSON property `videoViewability` + # @return [Google::Apis::DisplayvideoV1::DoubleVerifyVideoViewability] + attr_accessor :video_viewability + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @app_star_rating = args[:app_star_rating] if args.key?(:app_star_rating) + @avoided_age_ratings = args[:avoided_age_ratings] if args.key?(:avoided_age_ratings) + @brand_safety_categories = args[:brand_safety_categories] if args.key?(:brand_safety_categories) + @display_viewability = args[:display_viewability] if args.key?(:display_viewability) + @fraud_invalid_traffic = args[:fraud_invalid_traffic] if args.key?(:fraud_invalid_traffic) + @video_viewability = args[:video_viewability] if args.key?(:video_viewability) + end + end + + # Details of DoubleVerify star ratings settings. + class DoubleVerifyAppStarRating + include Google::Apis::Core::Hashable + + # Avoid bidding on apps with insufficient star ratings. + # Corresponds to the JSON property `avoidInsufficientStarRating` + # @return [Boolean] + attr_accessor :avoid_insufficient_star_rating + alias_method :avoid_insufficient_star_rating?, :avoid_insufficient_star_rating + + # Avoid bidding on apps with the star ratings. + # Corresponds to the JSON property `avoidedStarRating` + # @return [String] + attr_accessor :avoided_star_rating + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @avoid_insufficient_star_rating = args[:avoid_insufficient_star_rating] if args.key?(:avoid_insufficient_star_rating) + @avoided_star_rating = args[:avoided_star_rating] if args.key?(:avoided_star_rating) + end + end + + # Settings for brand safety controls. + class DoubleVerifyBrandSafetyCategories + include Google::Apis::Core::Hashable + + # Unknown or unrateable. + # Corresponds to the JSON property `avoidUnknownBrandSafetyCategory` + # @return [Boolean] + attr_accessor :avoid_unknown_brand_safety_category + alias_method :avoid_unknown_brand_safety_category?, :avoid_unknown_brand_safety_category + + # Brand safety high severity avoidance categories. + # Corresponds to the JSON property `avoidedHighSeverityCategories` + # @return [Array] + attr_accessor :avoided_high_severity_categories + + # Brand safety medium severity avoidance categories. + # Corresponds to the JSON property `avoidedMediumSeverityCategories` + # @return [Array] + attr_accessor :avoided_medium_severity_categories + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @avoid_unknown_brand_safety_category = args[:avoid_unknown_brand_safety_category] if args.key?(:avoid_unknown_brand_safety_category) + @avoided_high_severity_categories = args[:avoided_high_severity_categories] if args.key?(:avoided_high_severity_categories) + @avoided_medium_severity_categories = args[:avoided_medium_severity_categories] if args.key?(:avoided_medium_severity_categories) + end + end + + # Details of DoubleVerify display viewability settings. + class DoubleVerifyDisplayViewability + include Google::Apis::Core::Hashable + + # Target web and app inventory to maximize IAB viewable rate. + # Corresponds to the JSON property `iab` + # @return [String] + attr_accessor :iab + + # Target web and app inventory to maximize 100% viewable duration. + # Corresponds to the JSON property `viewableDuring` + # @return [String] + attr_accessor :viewable_during + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @iab = args[:iab] if args.key?(:iab) + @viewable_during = args[:viewable_during] if args.key?(:viewable_during) + end + end + + # DoubleVerify Fraud & Invalid Traffic settings. + class DoubleVerifyFraudInvalidTraffic + include Google::Apis::Core::Hashable + + # Insufficient Historical Fraud & IVT Stats. + # Corresponds to the JSON property `avoidInsufficientOption` + # @return [Boolean] + attr_accessor :avoid_insufficient_option + alias_method :avoid_insufficient_option?, :avoid_insufficient_option + + # Avoid Sites and Apps with historical Fraud & IVT. + # Corresponds to the JSON property `avoidedFraudOption` + # @return [String] + attr_accessor :avoided_fraud_option + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @avoid_insufficient_option = args[:avoid_insufficient_option] if args.key?(:avoid_insufficient_option) + @avoided_fraud_option = args[:avoided_fraud_option] if args.key?(:avoided_fraud_option) + end + end + + # Details of DoubleVerify video viewability settings. + class DoubleVerifyVideoViewability + include Google::Apis::Core::Hashable + + # Target inventory to maximize impressions with 400x300 or greater player + # size. + # Corresponds to the JSON property `playerImpressionRate` + # @return [String] + attr_accessor :player_impression_rate + + # Target web inventory to maximize IAB viewable rate. + # Corresponds to the JSON property `videoIab` + # @return [String] + attr_accessor :video_iab + + # Target web inventory to maximize fully viewable rate. + # Corresponds to the JSON property `videoViewableRate` + # @return [String] + attr_accessor :video_viewable_rate + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @player_impression_rate = args[:player_impression_rate] if args.key?(:player_impression_rate) + @video_iab = args[:video_iab] if args.key?(:video_iab) + @video_viewable_rate = args[:video_viewable_rate] if args.key?(:video_viewable_rate) + end + end + + # A generic empty message that you can re-use to avoid defining duplicated + # empty messages in your APIs. A typical example is to use it as the request + # or the response type of an API method. For instance: + # service Foo ` + # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); + # ` + # The JSON representation for `Empty` is empty JSON object ````. + class Empty + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Assigned environment targeting option details. This will be populated + # in the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_ENVIRONMENT`. + class EnvironmentAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The serving environment. + # Corresponds to the JSON property `environment` + # @return [String] + attr_accessor :environment + + # Required. The targeting_option_id of a + # TargetingOption of type `TARGETING_TYPE_ENVIRONMENT` (e.g., "508010" + # for targeting the `ENVIRONMENT_WEB_OPTIMIZED` option). + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @environment = args[:environment] if args.key?(:environment) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + end + end + + # Represents a targetable environment. This will be populated in the + # environment_details field of a + # TargetingOption when targeting_type is + # `TARGETING_TYPE_ENVIRONMENT`. + class EnvironmentTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The serving environment. + # Corresponds to the JSON property `environment` + # @return [String] + attr_accessor :environment + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @environment = args[:environment] if args.key?(:environment) + end + end + + # Details for assigned exchange targeting option. This will be populated in + # the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_EXCHANGE`. + class ExchangeAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Required. The targeting_option_id of a + # TargetingOption of type `TARGETING_TYPE_EXCHANGE`. + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + end + end + + # Exchange review status for the creative. + class ExchangeReviewStatus + include Google::Apis::Core::Hashable + + # The exchange reviewing the creative. + # Corresponds to the JSON property `exchange` + # @return [String] + attr_accessor :exchange + + # Status of the exchange review. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @exchange = args[:exchange] if args.key?(:exchange) + @status = args[:status] if args.key?(:status) + end + end + + # Represents a targetable exchange. This will be populated in the + # exchange_details field + # of a TargetingOption when + # targeting_type is + # `TARGETING_TYPE_EXCHANGE`. + class ExchangeTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The type of exchange. + # Corresponds to the JSON property `exchange` + # @return [String] + attr_accessor :exchange + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @exchange = args[:exchange] if args.key?(:exchange) + end + end + + # Exit event of the creative. + class ExitEvent + include Google::Apis::Core::Hashable + + # The name of the click tag of the exit event. + # The name must be unique within one creative. + # Leave it empty or unset for creatives containing image assets only. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The name used to identify this event in reports. + # Leave it empty or unset for creatives containing image assets only. + # Corresponds to the JSON property `reportingName` + # @return [String] + attr_accessor :reporting_name + + # Required. The type of the exit event. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # Required. The click through URL of the exit event. + # This is required when type is: + # * `EXIT_EVENT_TYPE_DEFAULT` + # * `EXIT_EVENT_TYPE_BACKUP` + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @reporting_name = args[:reporting_name] if args.key?(:reporting_name) + @type = args[:type] if args.key?(:type) + @url = args[:url] if args.key?(:url) + end + end + + # Describes a first or third party audience list used for targeting. + # First party audiences are created via usage of client data. + # Third party audiences are provided by Third Party data providers and can only + # be licensed to customers. + class FirstAndThirdPartyAudience + include Google::Apis::Core::Hashable + + # Output only. The display name of the first and third party audience. + # . + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Output only. The unique ID of the first and third party audience. Assigned by + # the + # system. + # Corresponds to the JSON property `firstAndThirdPartyAudienceId` + # @return [Fixnum] + attr_accessor :first_and_third_party_audience_id + + # Output only. Whether the audience is a first or third party audience. + # . + # Corresponds to the JSON property `firstAndThirdPartyAudienceType` + # @return [String] + attr_accessor :first_and_third_party_audience_type + + # Output only. The resource name of the first and third party audience. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + @first_and_third_party_audience_id = args[:first_and_third_party_audience_id] if args.key?(:first_and_third_party_audience_id) + @first_and_third_party_audience_type = args[:first_and_third_party_audience_type] if args.key?(:first_and_third_party_audience_type) + @name = args[:name] if args.key?(:name) + end + end + + # Details of first and third party audience group. + # All first and third party audience targeting settings are logically ‘OR’ of + # each other. + class FirstAndThirdPartyAudienceGroup + include Google::Apis::Core::Hashable + + # Required. All first and third party audience targeting settings in first and + # third party audience group. + # Repeated settings with same id are not allowed. + # Corresponds to the JSON property `settings` + # @return [Array] + attr_accessor :settings + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @settings = args[:settings] if args.key?(:settings) + end + end + + # Details of first and third party audience targeting setting. + class FirstAndThirdPartyAudienceTargetingSetting + include Google::Apis::Core::Hashable + + # Required. First and third party audience id of the first and third party + # audience + # targeting setting. This id is + # first_and_third_party_audience_id. + # Corresponds to the JSON property `firstAndThirdPartyAudienceId` + # @return [Fixnum] + attr_accessor :first_and_third_party_audience_id + + # The recency of the first and third party audience targeting setting. + # Only applicable to first party audiences, otherwise + # will be ignored. For more info, refer to + # https://support.google.com/displayvideo/answer/2949947#recency + # When unspecified, no recency limit will be used. + # Corresponds to the JSON property `recency` + # @return [String] + attr_accessor :recency + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @first_and_third_party_audience_id = args[:first_and_third_party_audience_id] if args.key?(:first_and_third_party_audience_id) + @recency = args[:recency] if args.key?(:recency) + end + end + + # A strategy that uses a fixed bidding price. + class FixedBidStrategy + include Google::Apis::Core::Hashable + + # The fixed bid amount, in micros of the advertiser's currency. + # For insertion order entity, + # bid_amount_micros should be set as 0. + # For line item entity, + # bid_amount_micros must be greater + # than or equal to billable unit of the given currency and smaller than or + # equal to the upper limit 1000000000. + # For example, 1500000 represents 1.5 standard units of the currency. + # Corresponds to the JSON property `bidAmountMicros` + # @return [Fixnum] + attr_accessor :bid_amount_micros + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bid_amount_micros = args[:bid_amount_micros] if args.key?(:bid_amount_micros) + end + end + + # A single Floodlight group. + class FloodlightGroup + include Google::Apis::Core::Hashable + + # Configuration for custom Active View video viewability metrics. + # Corresponds to the JSON property `activeViewConfig` + # @return [Google::Apis::DisplayvideoV1::ActiveViewVideoViewabilityMetricConfig] + attr_accessor :active_view_config + + # User-defined custom variables owned by the Floodlight group. + # Use custom Floodlight variables to create reporting data that is tailored + # to your unique business needs. Custom Floodlight variables use the keys + # `U1=`, `U2=`, and so on, and can take any values that you choose to pass to + # them. You can use them to track virtually any type of data that you collect + # about your customers, such as the genre of movie that a customer purchases, + # the country to which the item is shipped, and so on. + # Custom Floodlight variables may not be used to pass any data that could be + # used or recognized as personally identifiable information (PII). + # Example: + # `custom_variables ` + # fields ` + # "U1": value ` number_value: 123.4 `, + # "U2": value ` string_value: "MyVariable2" `, + # "U3": value ` string_value: "MyVariable3" ` + # ` + # `` + # Acceptable values for keys are "U1" through "U100", inclusive. String + # values must be less than 64 characters long, and cannot contain the + # following characters: `"<>`. + # Corresponds to the JSON property `customVariables` + # @return [Hash] + attr_accessor :custom_variables + + # Required. The display name of the Floodlight group. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Output only. The unique ID of the Floodlight group. Assigned by the system. + # Corresponds to the JSON property `floodlightGroupId` + # @return [Fixnum] + attr_accessor :floodlight_group_id + + # Specifies how many days into the past to look when determining whether to + # record a conversion. + # Corresponds to the JSON property `lookbackWindow` + # @return [Google::Apis::DisplayvideoV1::LookbackWindow] + attr_accessor :lookback_window + + # Output only. The resource name of the Floodlight group. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Required. The web tag type enabled for the Floodlight group. + # Corresponds to the JSON property `webTagType` + # @return [String] + attr_accessor :web_tag_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @active_view_config = args[:active_view_config] if args.key?(:active_view_config) + @custom_variables = args[:custom_variables] if args.key?(:custom_variables) + @display_name = args[:display_name] if args.key?(:display_name) + @floodlight_group_id = args[:floodlight_group_id] if args.key?(:floodlight_group_id) + @lookback_window = args[:lookback_window] if args.key?(:lookback_window) + @name = args[:name] if args.key?(:name) + @web_tag_type = args[:web_tag_type] if args.key?(:web_tag_type) + end + end + + # Settings that control the number of times a user may be shown with the same + # ad during a given time period. + class FrequencyCap + include Google::Apis::Core::Hashable + + # The maximum number of times a user may be shown with the same ad + # during this period. Must be greater than 0. + # Applicable when unlimited is `false`. + # Corresponds to the JSON property `maxImpressions` + # @return [Fixnum] + attr_accessor :max_impressions + + # The time unit in which the frequency cap will be applied. + # Applicable when unlimited is `false`. + # Corresponds to the JSON property `timeUnit` + # @return [String] + attr_accessor :time_unit + + # The number of time_unit the frequency cap will + # last. + # Applicable when unlimited is `false`. + # The following restrictions apply based on the value of + # time_unit: + # * `TIME_UNIT_LIFETIME` - this field is output only and will + # default to 1 + # * `TIME_UNIT_MONTHS` - must be between 1 and 2 + # * `TIME_UNIT_WEEKS` - must be between 1 and 4 + # * `TIME_UNIT_DAYS` - must be between 1 and 6 + # * `TIME_UNIT_HOURS` - must be between 1 and 23 + # * `TIME_UNIT_MINUTES` - must be between 1 and 59 + # Corresponds to the JSON property `timeUnitCount` + # @return [Fixnum] + attr_accessor :time_unit_count + + # Whether unlimited frequency capping is applied. When this field is set to + # `true`, the remaining frequency cap fields are not applicable. + # Corresponds to the JSON property `unlimited` + # @return [Boolean] + attr_accessor :unlimited + alias_method :unlimited?, :unlimited + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @max_impressions = args[:max_impressions] if args.key?(:max_impressions) + @time_unit = args[:time_unit] if args.key?(:time_unit) + @time_unit_count = args[:time_unit_count] if args.key?(:time_unit_count) + @unlimited = args[:unlimited] if args.key?(:unlimited) + end + end + + # Details for assigned gender targeting option. This will be populated in + # the details field of an AssignedTargetingOption when + # targeting_type is + # `TARTGETING_TYPE_GENDER`. + class GenderAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The gender of the audience. + # Corresponds to the JSON property `gender` + # @return [String] + attr_accessor :gender + + # Required. The targeting_option_id of a + # TargetingOption of type `TARGETING_TYPE_GENDER`. + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @gender = args[:gender] if args.key?(:gender) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + end + end + + # Represents a targetable gender. This will be populated in the + # gender_details field of a TargetingOption + # when targeting_type is + # `TARGETING_TYPE_GENDER`. + class GenderTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The gender of an audience. + # Corresponds to the JSON property `gender` + # @return [String] + attr_accessor :gender + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @gender = args[:gender] if args.key?(:gender) + end + end + + # Details for assigned geographic region targeting option. This will be + # populated in the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_GEO_REGION`. + class GeoRegionAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The display name of the geographic region (e.g., "Ontario, Canada" + # ). + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Output only. The type of geographic region targeting. + # Corresponds to the JSON property `geoRegionType` + # @return [String] + attr_accessor :geo_region_type + + # Indicates if this option is being negatively targeted. + # Corresponds to the JSON property `negative` + # @return [Boolean] + attr_accessor :negative + alias_method :negative?, :negative + + # Required. The targeting_option_id of a + # TargetingOption of type `TARGETING_TYPE_GEO_REGION`. + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + @geo_region_type = args[:geo_region_type] if args.key?(:geo_region_type) + @negative = args[:negative] if args.key?(:negative) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + end + end + + # Represents a targetable geographic region. This will be populated in the + # geo_region_details field when + # targeting_type is + # `TARGETING_TYPE_GEO_REGION`. + class GeoRegionTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The display name of the geographic region (e.g., "Ontario, Canada" + # ). + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Output only. The type of geographic region targeting. + # Corresponds to the JSON property `geoRegionType` + # @return [String] + attr_accessor :geo_region_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + @geo_region_type = args[:geo_region_type] if args.key?(:geo_region_type) + end + end + + # Describes a Google audience resource. + # Includes Google audience lists. + class GoogleAudience + include Google::Apis::Core::Hashable + + # Output only. The display name of the Google audience. + # . + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Output only. The unique ID of the Google audience. Assigned by the system. + # Corresponds to the JSON property `googleAudienceId` + # @return [Fixnum] + attr_accessor :google_audience_id + + # Output only. The type of Google audience. + # . + # Corresponds to the JSON property `googleAudienceType` + # @return [String] + attr_accessor :google_audience_type + + # Output only. The resource name of the google audience. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + @google_audience_id = args[:google_audience_id] if args.key?(:google_audience_id) + @google_audience_type = args[:google_audience_type] if args.key?(:google_audience_type) + @name = args[:name] if args.key?(:name) + end + end + + # Details of Google audience group. + # All Google audience targeting settings are logically ‘OR’ of each other. + class GoogleAudienceGroup + include Google::Apis::Core::Hashable + + # Required. All Google audience targeting settings in Google audience group. + # Repeated settings with same id will be ignored. + # Corresponds to the JSON property `settings` + # @return [Array] + attr_accessor :settings + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @settings = args[:settings] if args.key?(:settings) + end + end + + # Details of Google audience targeting setting. + class GoogleAudienceTargetingSetting + include Google::Apis::Core::Hashable + + # Required. Google audience id of the Google audience targeting setting. + # This id is google_audience_id. + # Corresponds to the JSON property `googleAudienceId` + # @return [Fixnum] + attr_accessor :google_audience_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @google_audience_id = args[:google_audience_id] if args.key?(:google_audience_id) + end + end + # Media resource. class GoogleBytestreamMedia include Google::Apis::Core::Hashable @@ -94,6 +3878,57 @@ module Google end end + # Details for assigned household income targeting option. This will be + # populated in the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_HOUSEHOLD_INCOME`. + class HouseholdIncomeAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The household income of the audience. + # Corresponds to the JSON property `householdIncome` + # @return [String] + attr_accessor :household_income + + # Required. The targeting_option_id of a + # TargetingOption of type `TARGETING_TYPE_HOUSEHOLD_INCOME`. + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @household_income = args[:household_income] if args.key?(:household_income) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + end + end + + # Represents a targetable household income. This will be populated in the + # household_income_details field of + # a TargetingOption when targeting_type is + # `TARGETING_TYPE_HOUSEHOLD_INCOME`. + class HouseholdIncomeTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The household income of an audience. + # Corresponds to the JSON property `householdIncome` + # @return [String] + attr_accessor :household_income + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @household_income = args[:household_income] if args.key?(:household_income) + end + end + # A filtering option that filters entities by their entity IDs. class IdFilter include Google::Apis::Core::Hashable @@ -161,6 +3996,475 @@ module Google end end + # A single insertion order. + class InsertionOrder + include Google::Apis::Core::Hashable + + # Output only. The unique ID of the advertiser the insertion order belongs to. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Settings that control the bid strategy. + # Bid strategy determines the bid price. + # Corresponds to the JSON property `bidStrategy` + # @return [Google::Apis::DisplayvideoV1::BiddingStrategy] + attr_accessor :bid_strategy + + # Settings that control how insertion order budget is allocated. + # Corresponds to the JSON property `budget` + # @return [Google::Apis::DisplayvideoV1::InsertionOrderBudget] + attr_accessor :budget + + # Required. Immutable. The unique ID of the campaign that the insertion order + # belongs to. + # Corresponds to the JSON property `campaignId` + # @return [Fixnum] + attr_accessor :campaign_id + + # Required. The display name of the insertion order. + # Must be UTF-8 encoded with a maximum size of 240 bytes. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Required. Controls whether or not the insertion order can spend its budget + # and bid on inventory. + # * For + # CreateInsertionOrder method, + # only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use + # UpdateInsertionOrder method + # and update the status to `ENTITY_STATUS_ACTIVE` after creation. + # * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status + # from any other status. + # * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent + # campaign is not active. + # Corresponds to the JSON property `entityStatus` + # @return [String] + attr_accessor :entity_status + + # Settings that control the number of times a user may be shown with the same + # ad during a given time period. + # Corresponds to the JSON property `frequencyCap` + # @return [Google::Apis::DisplayvideoV1::FrequencyCap] + attr_accessor :frequency_cap + + # Output only. The unique ID of the insertion order. Assigned by the system. + # Corresponds to the JSON property `insertionOrderId` + # @return [Fixnum] + attr_accessor :insertion_order_id + + # Integration details of an entry. + # Corresponds to the JSON property `integrationDetails` + # @return [Google::Apis::DisplayvideoV1::IntegrationDetails] + attr_accessor :integration_details + + # Output only. The resource name of the insertion order. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Settings that control the rate at which a budget is spent. + # Corresponds to the JSON property `pacing` + # @return [Google::Apis::DisplayvideoV1::Pacing] + attr_accessor :pacing + + # The partner costs associated with the insertion order. + # If absent or empty in + # CreateInsertionOrder + # method, the newly created insertion order will inherit partner costs from + # the partner settings. + # Corresponds to the JSON property `partnerCosts` + # @return [Array] + attr_accessor :partner_costs + + # Settings that control the performance goal of a campaign or insertion order. + # Corresponds to the JSON property `performanceGoal` + # @return [Google::Apis::DisplayvideoV1::PerformanceGoal] + attr_accessor :performance_goal + + # Output only. The timestamp when the insertion order was last updated. + # Assigned by the system. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @bid_strategy = args[:bid_strategy] if args.key?(:bid_strategy) + @budget = args[:budget] if args.key?(:budget) + @campaign_id = args[:campaign_id] if args.key?(:campaign_id) + @display_name = args[:display_name] if args.key?(:display_name) + @entity_status = args[:entity_status] if args.key?(:entity_status) + @frequency_cap = args[:frequency_cap] if args.key?(:frequency_cap) + @insertion_order_id = args[:insertion_order_id] if args.key?(:insertion_order_id) + @integration_details = args[:integration_details] if args.key?(:integration_details) + @name = args[:name] if args.key?(:name) + @pacing = args[:pacing] if args.key?(:pacing) + @partner_costs = args[:partner_costs] if args.key?(:partner_costs) + @performance_goal = args[:performance_goal] if args.key?(:performance_goal) + @update_time = args[:update_time] if args.key?(:update_time) + end + end + + # Settings that control how insertion order budget is allocated. + class InsertionOrderBudget + include Google::Apis::Core::Hashable + + # The type of automation used to manage bid and budget for + # the insertion order. + # If this field is unspecified in creation, the value defaults to + # `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. + # Corresponds to the JSON property `automationType` + # @return [String] + attr_accessor :automation_type + + # Required. The list of budget segments. Use a budget segment to specify + # a specific budget for a given period of time an insertion order is running. + # Corresponds to the JSON property `budgetSegments` + # @return [Array] + attr_accessor :budget_segments + + # Required. Immutable. The budget unit specifies whether the budget is currency + # based or + # impression based. + # Corresponds to the JSON property `budgetUnit` + # @return [String] + attr_accessor :budget_unit + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @automation_type = args[:automation_type] if args.key?(:automation_type) + @budget_segments = args[:budget_segments] if args.key?(:budget_segments) + @budget_unit = args[:budget_unit] if args.key?(:budget_unit) + end + end + + # Settings that control the budget of a single budget segment. + class InsertionOrderBudgetSegment + include Google::Apis::Core::Hashable + + # Required. The budget amount the insertion order will spend for the given + # date_range. + # The amount is in micros. Must be greater than 0. For example, 500000000 + # represents 500 standard units of the currency. + # Corresponds to the JSON property `budgetAmountMicros` + # @return [Fixnum] + attr_accessor :budget_amount_micros + + # The ID of the campaign budget linked to this insertion order budget + # segment. + # Corresponds to the JSON property `campaignBudgetId` + # @return [Fixnum] + attr_accessor :campaign_budget_id + + # A date range. + # Corresponds to the JSON property `dateRange` + # @return [Google::Apis::DisplayvideoV1::DateRange] + attr_accessor :date_range + + # The budget segment description. It can be used to enter Purchase Order + # information for each budget segment and have that information printed on + # the invoices. + # Must be UTF-8 encoded with a length of no more than 80 characters. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @budget_amount_micros = args[:budget_amount_micros] if args.key?(:budget_amount_micros) + @campaign_budget_id = args[:campaign_budget_id] if args.key?(:campaign_budget_id) + @date_range = args[:date_range] if args.key?(:date_range) + @description = args[:description] if args.key?(:description) + end + end + + # Details of Integral Ad Science settings. + class IntegralAdScience + include Google::Apis::Core::Hashable + + # Display Viewability section (applicable to display line items only). + # Corresponds to the JSON property `displayViewability` + # @return [String] + attr_accessor :display_viewability + + # Brand Safety - **Unrateable**. + # Corresponds to the JSON property `excludeUnrateable` + # @return [Boolean] + attr_accessor :exclude_unrateable + alias_method :exclude_unrateable?, :exclude_unrateable + + # Ad Fraud settings. + # Corresponds to the JSON property `excludedAdFraudRisk` + # @return [String] + attr_accessor :excluded_ad_fraud_risk + + # Brand Safety - **Adult content**. + # Corresponds to the JSON property `excludedAdultRisk` + # @return [String] + attr_accessor :excluded_adult_risk + + # Brand Safety - **Alcohol**. + # Corresponds to the JSON property `excludedAlcoholRisk` + # @return [String] + attr_accessor :excluded_alcohol_risk + + # Brand Safety - **Drugs**. + # Corresponds to the JSON property `excludedDrugsRisk` + # @return [String] + attr_accessor :excluded_drugs_risk + + # Brand Safety - **Gambling**. + # Corresponds to the JSON property `excludedGamblingRisk` + # @return [String] + attr_accessor :excluded_gambling_risk + + # Brand Safety - **Hate speech**. + # Corresponds to the JSON property `excludedHateSpeechRisk` + # @return [String] + attr_accessor :excluded_hate_speech_risk + + # Brand Safety - **Illegal downloads**. + # Corresponds to the JSON property `excludedIllegalDownloadsRisk` + # @return [String] + attr_accessor :excluded_illegal_downloads_risk + + # Brand Safety - **Offensive language**. + # Corresponds to the JSON property `excludedOffensiveLanguageRisk` + # @return [String] + attr_accessor :excluded_offensive_language_risk + + # Brand Safety - **Violence**. + # Corresponds to the JSON property `excludedViolenceRisk` + # @return [String] + attr_accessor :excluded_violence_risk + + # True advertising quality (applicable to Display line items only). + # Corresponds to the JSON property `traqScoreOption` + # @return [String] + attr_accessor :traq_score_option + + # Video Viewability Section (applicable to video line items only). + # Corresponds to the JSON property `videoViewability` + # @return [String] + attr_accessor :video_viewability + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_viewability = args[:display_viewability] if args.key?(:display_viewability) + @exclude_unrateable = args[:exclude_unrateable] if args.key?(:exclude_unrateable) + @excluded_ad_fraud_risk = args[:excluded_ad_fraud_risk] if args.key?(:excluded_ad_fraud_risk) + @excluded_adult_risk = args[:excluded_adult_risk] if args.key?(:excluded_adult_risk) + @excluded_alcohol_risk = args[:excluded_alcohol_risk] if args.key?(:excluded_alcohol_risk) + @excluded_drugs_risk = args[:excluded_drugs_risk] if args.key?(:excluded_drugs_risk) + @excluded_gambling_risk = args[:excluded_gambling_risk] if args.key?(:excluded_gambling_risk) + @excluded_hate_speech_risk = args[:excluded_hate_speech_risk] if args.key?(:excluded_hate_speech_risk) + @excluded_illegal_downloads_risk = args[:excluded_illegal_downloads_risk] if args.key?(:excluded_illegal_downloads_risk) + @excluded_offensive_language_risk = args[:excluded_offensive_language_risk] if args.key?(:excluded_offensive_language_risk) + @excluded_violence_risk = args[:excluded_violence_risk] if args.key?(:excluded_violence_risk) + @traq_score_option = args[:traq_score_option] if args.key?(:traq_score_option) + @video_viewability = args[:video_viewability] if args.key?(:video_viewability) + end + end + + # Integration details of an entry. + class IntegrationDetails + include Google::Apis::Core::Hashable + + # Additional details of the entry in string format. + # Must be UTF-8 encoded with a length of no more than 1000 characters. + # Corresponds to the JSON property `details` + # @return [String] + attr_accessor :details + + # An external identifier to be associated with the entry. + # The integration code will show up together with the entry in many + # places in the system, for example, reporting. + # Must be UTF-8 encoded with a length of no more than 500 characters. + # Corresponds to the JSON property `integrationCode` + # @return [String] + attr_accessor :integration_code + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @details = args[:details] if args.key?(:details) + @integration_code = args[:integration_code] if args.key?(:integration_code) + end + end + + # An inventory source. + class InventorySource + include Google::Apis::Core::Hashable + + # Whether the inventory source has a guaranteed or non-guaranteed delivery. + # Corresponds to the JSON property `commitment` + # @return [String] + attr_accessor :commitment + + # The creative requirements of the inventory source. + # Not applicable for auction packages. + # Corresponds to the JSON property `creativeConfigs` + # @return [Array] + attr_accessor :creative_configs + + # The ID in the exchange space that uniquely identifies the inventory source. + # Must be unique across buyers within each exchange but not necessarily + # unique across exchanges. + # Corresponds to the JSON property `dealId` + # @return [String] + attr_accessor :deal_id + + # The delivery method of the inventory source. + # * For non-guaranteed inventory sources, the only acceptable value is + # `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. + # * For guaranteed inventory sources, acceptable values are + # `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and + # `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. + # Corresponds to the JSON property `deliveryMethod` + # @return [String] + attr_accessor :delivery_method + + # The display name of the inventory source. + # Must be UTF-8 encoded with a maximum size of 240 bytes. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # The exchange to which the inventory source belongs. + # Corresponds to the JSON property `exchange` + # @return [String] + attr_accessor :exchange + + # Output only. The unique ID of the inventory source. Assigned by the system. + # Corresponds to the JSON property `inventorySourceId` + # @return [Fixnum] + attr_accessor :inventory_source_id + + # Denotes the type of the inventory source. + # Corresponds to the JSON property `inventorySourceType` + # @return [String] + attr_accessor :inventory_source_type + + # Output only. The resource name of the inventory source. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The publisher/seller name of the inventory source. + # Corresponds to the JSON property `publisherName` + # @return [String] + attr_accessor :publisher_name + + # The rate related settings of the inventory source. + # Corresponds to the JSON property `rateDetails` + # @return [Google::Apis::DisplayvideoV1::RateDetails] + attr_accessor :rate_details + + # The status related settings of the inventory source. + # Corresponds to the JSON property `status` + # @return [Google::Apis::DisplayvideoV1::InventorySourceStatus] + attr_accessor :status + + # A time range. + # Corresponds to the JSON property `timeRange` + # @return [Google::Apis::DisplayvideoV1::TimeRange] + attr_accessor :time_range + + # Output only. The timestamp when the inventory source was last updated. + # Assigned by the + # system. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @commitment = args[:commitment] if args.key?(:commitment) + @creative_configs = args[:creative_configs] if args.key?(:creative_configs) + @deal_id = args[:deal_id] if args.key?(:deal_id) + @delivery_method = args[:delivery_method] if args.key?(:delivery_method) + @display_name = args[:display_name] if args.key?(:display_name) + @exchange = args[:exchange] if args.key?(:exchange) + @inventory_source_id = args[:inventory_source_id] if args.key?(:inventory_source_id) + @inventory_source_type = args[:inventory_source_type] if args.key?(:inventory_source_type) + @name = args[:name] if args.key?(:name) + @publisher_name = args[:publisher_name] if args.key?(:publisher_name) + @rate_details = args[:rate_details] if args.key?(:rate_details) + @status = args[:status] if args.key?(:status) + @time_range = args[:time_range] if args.key?(:time_range) + @update_time = args[:update_time] if args.key?(:update_time) + end + end + + # Targeting details for inventory source. This will be + # populated in the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_INVENTORY_SOURCE`. + class InventorySourceAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Required. ID of the inventory source. Should refer to the + # inventory_source_id field of an + # InventorySource resource. + # Corresponds to the JSON property `inventorySourceId` + # @return [Fixnum] + attr_accessor :inventory_source_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @inventory_source_id = args[:inventory_source_id] if args.key?(:inventory_source_id) + end + end + + # The configuration for display creatives. + class InventorySourceDisplayCreativeConfig + include Google::Apis::Core::Hashable + + # Dimensions. + # Corresponds to the JSON property `creativeSize` + # @return [Google::Apis::DisplayvideoV1::Dimensions] + attr_accessor :creative_size + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @creative_size = args[:creative_size] if args.key?(:creative_size) + end + end + # A filtering option for filtering on Inventory Source entities. class InventorySourceFilter include Google::Apis::Core::Hashable @@ -184,6 +4488,1337 @@ module Google end end + # A collection of targetable inventory sources. + class InventorySourceGroup + include Google::Apis::Core::Hashable + + # Required. The display name of the inventory source group. + # Must be UTF-8 encoded with a maximum size of 240 bytes. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Output only. The unique ID of the inventory source group. Assigned by the + # system. + # Corresponds to the JSON property `inventorySourceGroupId` + # @return [Fixnum] + attr_accessor :inventory_source_group_id + + # Output only. The resource name of the inventory source group. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + @inventory_source_group_id = args[:inventory_source_group_id] if args.key?(:inventory_source_group_id) + @name = args[:name] if args.key?(:name) + end + end + + # Targeting details for inventory source group. This will be + # populated in the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. + class InventorySourceGroupAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Required. ID of the inventory source group. Should refer to the + # inventory_source_group_id + # field of an InventorySourceGroup resource. + # Corresponds to the JSON property `inventorySourceGroupId` + # @return [Fixnum] + attr_accessor :inventory_source_group_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @inventory_source_group_id = args[:inventory_source_group_id] if args.key?(:inventory_source_group_id) + end + end + + # The status related settings of the inventory source. + class InventorySourceStatus + include Google::Apis::Core::Hashable + + # Output only. The configuration status of the inventory source. + # Only applicable for guaranteed inventory sources. + # Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and + # `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. + # An inventory source must be configured (fill in the required fields, choose + # creatives, and select a default campaign) before it can serve. + # Corresponds to the JSON property `configStatus` + # @return [String] + attr_accessor :config_status + + # The user-provided reason for pausing this inventory source. + # Must not exceed 100 characters. + # Only applicable when entity_status + # is set to `ENTITY_STATUS_PAUSED`. + # Corresponds to the JSON property `entityPauseReason` + # @return [String] + attr_accessor :entity_pause_reason + + # Whether or not the inventory source is servable. + # Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and + # `ENTITY_STATUS_PAUSED`. + # Default value is `ENTITY_STATUS_ACTIVE`. + # Corresponds to the JSON property `entityStatus` + # @return [String] + attr_accessor :entity_status + + # Output only. The seller-provided reason for pausing this inventory source. + # Only applicable for inventory sources synced directly from the + # publishers and when seller_status + # is set to `ENTITY_STATUS_PAUSED`. + # Corresponds to the JSON property `sellerPauseReason` + # @return [String] + attr_accessor :seller_pause_reason + + # Output only. The status set by the seller for the inventory source. + # Only applicable for inventory sources synced directly from the + # publishers. + # Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`. + # Corresponds to the JSON property `sellerStatus` + # @return [String] + attr_accessor :seller_status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @config_status = args[:config_status] if args.key?(:config_status) + @entity_pause_reason = args[:entity_pause_reason] if args.key?(:entity_pause_reason) + @entity_status = args[:entity_status] if args.key?(:entity_status) + @seller_pause_reason = args[:seller_pause_reason] if args.key?(:seller_pause_reason) + @seller_status = args[:seller_status] if args.key?(:seller_status) + end + end + + # The configuration for video creatives. + class InventorySourceVideoCreativeConfig + include Google::Apis::Core::Hashable + + # The duration requirements for the video creatives that can be assigned to + # the inventory source. + # Corresponds to the JSON property `duration` + # @return [String] + attr_accessor :duration + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @duration = args[:duration] if args.key?(:duration) + end + end + + # Details for assigned keyword targeting option. This will be populated in the + # details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_KEYWORD`. + class KeywordAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Required. The keyword, for example `car insurance`. + # Positive keyword cannot be offensive word. + # Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number + # of characters is 80. Maximum number of words is 10. + # Corresponds to the JSON property `keyword` + # @return [String] + attr_accessor :keyword + + # Indicates if this option is being negatively targeted. + # Corresponds to the JSON property `negative` + # @return [Boolean] + attr_accessor :negative + alias_method :negative?, :negative + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @keyword = args[:keyword] if args.key?(:keyword) + @negative = args[:negative] if args.key?(:negative) + end + end + + # Details for assigned language targeting option. This will be populated in the + # details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_LANGUAGE`. + class LanguageAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The display name of the language (e.g., "French"). + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Indicates if this option is being negatively targeted. All assigned + # language targeting options on the same line item must have the same value + # for this field. + # Corresponds to the JSON property `negative` + # @return [Boolean] + attr_accessor :negative + alias_method :negative?, :negative + + # Required. The targeting_option_id of a + # TargetingOption of type `TARGETING_TYPE_LANGUAGE`. + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + @negative = args[:negative] if args.key?(:negative) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + end + end + + # Represents a targetable language. This will be populated in the + # language_details field when + # targeting_type is + # `TARGETING_TYPE_LANGUAGE`. + class LanguageTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The display name of the language (e.g., "French"). + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + end + end + + # A single line item. + class LineItem + include Google::Apis::Core::Hashable + + # Output only. The unique ID of the advertiser the line item belongs to. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Settings that control the bid strategy. + # Bid strategy determines the bid price. + # Corresponds to the JSON property `bidStrategy` + # @return [Google::Apis::DisplayvideoV1::BiddingStrategy] + attr_accessor :bid_strategy + + # Settings that control how budget is allocated. + # Corresponds to the JSON property `budget` + # @return [Google::Apis::DisplayvideoV1::LineItemBudget] + attr_accessor :budget + + # Output only. The unique ID of the campaign that the line item belongs to. + # Corresponds to the JSON property `campaignId` + # @return [Fixnum] + attr_accessor :campaign_id + + # Settings that control how conversions are counted. + # All post-click conversions will be counted. A percentage value can be set + # for post-view conversions counting. + # Corresponds to the JSON property `conversionCounting` + # @return [Google::Apis::DisplayvideoV1::ConversionCountingConfig] + attr_accessor :conversion_counting + + # The IDs of the creatives associated with the line item. + # Corresponds to the JSON property `creativeIds` + # @return [Array] + attr_accessor :creative_ids + + # Required. The display name of the line item. + # Must be UTF-8 encoded with a maximum size of 240 bytes. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Required. Controls whether or not the line item can spend its budget and + # bid on inventory. + # * For CreateLineItem method, only + # `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use + # UpdateLineItem method and update the + # status to `ENTITY_STATUS_ACTIVE` after creation. + # * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from + # any other status. + # * If the line item's parent insertion order is not active, the line item + # can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. + # Corresponds to the JSON property `entityStatus` + # @return [String] + attr_accessor :entity_status + + # Settings that control the active duration of a line item. + # Corresponds to the JSON property `flight` + # @return [Google::Apis::DisplayvideoV1::LineItemFlight] + attr_accessor :flight + + # Settings that control the number of times a user may be shown with the same + # ad during a given time period. + # Corresponds to the JSON property `frequencyCap` + # @return [Google::Apis::DisplayvideoV1::FrequencyCap] + attr_accessor :frequency_cap + + # Required. Immutable. The unique ID of the insertion order that the line item + # belongs to. + # Corresponds to the JSON property `insertionOrderId` + # @return [Fixnum] + attr_accessor :insertion_order_id + + # Integration details of an entry. + # Corresponds to the JSON property `integrationDetails` + # @return [Google::Apis::DisplayvideoV1::IntegrationDetails] + attr_accessor :integration_details + + # The IDs of the private inventory sources assigned to the line item. + # Corresponds to the JSON property `inventorySourceIds` + # @return [Array] + attr_accessor :inventory_source_ids + + # Output only. The unique ID of the line item. Assigned by the system. + # Corresponds to the JSON property `lineItemId` + # @return [Fixnum] + attr_accessor :line_item_id + + # Required. Immutable. The type of the line item. + # Corresponds to the JSON property `lineItemType` + # @return [String] + attr_accessor :line_item_type + + # Output only. The resource name of the line item. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Settings that control the rate at which a budget is spent. + # Corresponds to the JSON property `pacing` + # @return [Google::Apis::DisplayvideoV1::Pacing] + attr_accessor :pacing + + # The partner costs associated with the line item. + # If absent or empty in CreateLineItem + # method, the newly created line item will inherit partner costs from its + # parent insertion order. + # Corresponds to the JSON property `partnerCosts` + # @return [Array] + attr_accessor :partner_costs + + # Settings that control how partner revenue is calculated. + # Corresponds to the JSON property `partnerRevenueModel` + # @return [Google::Apis::DisplayvideoV1::PartnerRevenueModel] + attr_accessor :partner_revenue_model + + # Output only. The timestamp when the line item was last updated. Assigned by + # the system. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @bid_strategy = args[:bid_strategy] if args.key?(:bid_strategy) + @budget = args[:budget] if args.key?(:budget) + @campaign_id = args[:campaign_id] if args.key?(:campaign_id) + @conversion_counting = args[:conversion_counting] if args.key?(:conversion_counting) + @creative_ids = args[:creative_ids] if args.key?(:creative_ids) + @display_name = args[:display_name] if args.key?(:display_name) + @entity_status = args[:entity_status] if args.key?(:entity_status) + @flight = args[:flight] if args.key?(:flight) + @frequency_cap = args[:frequency_cap] if args.key?(:frequency_cap) + @insertion_order_id = args[:insertion_order_id] if args.key?(:insertion_order_id) + @integration_details = args[:integration_details] if args.key?(:integration_details) + @inventory_source_ids = args[:inventory_source_ids] if args.key?(:inventory_source_ids) + @line_item_id = args[:line_item_id] if args.key?(:line_item_id) + @line_item_type = args[:line_item_type] if args.key?(:line_item_type) + @name = args[:name] if args.key?(:name) + @pacing = args[:pacing] if args.key?(:pacing) + @partner_costs = args[:partner_costs] if args.key?(:partner_costs) + @partner_revenue_model = args[:partner_revenue_model] if args.key?(:partner_revenue_model) + @update_time = args[:update_time] if args.key?(:update_time) + end + end + + # Settings that control how budget is allocated. + class LineItemBudget + include Google::Apis::Core::Hashable + + # Required. The type of the budget allocation. + # `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when + # automatic budget allocation is enabled for the parent insertion order. + # Corresponds to the JSON property `budgetAllocationType` + # @return [String] + attr_accessor :budget_allocation_type + + # Output only. The budget unit specifies whether the budget is currency based + # or impression based. This value is inherited from the parent insertion + # order. + # Corresponds to the JSON property `budgetUnit` + # @return [String] + attr_accessor :budget_unit + + # The maximum budget amount the line item will spend. Must be greater than 0. + # When budget_allocation_type is: + # * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable + # and is set by the system. + # * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if + # budget_unit is: + # - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount + # to spend, in micros of the advertiser's currency. For example, 1500000 + # represents 1.5 standard units of the currency. + # - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number + # of impressions to serve. + # * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not + # applicable and will be ignored by the system. + # Corresponds to the JSON property `maxAmount` + # @return [Fixnum] + attr_accessor :max_amount + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @budget_allocation_type = args[:budget_allocation_type] if args.key?(:budget_allocation_type) + @budget_unit = args[:budget_unit] if args.key?(:budget_unit) + @max_amount = args[:max_amount] if args.key?(:max_amount) + end + end + + # Settings that control the active duration of a line item. + class LineItemFlight + include Google::Apis::Core::Hashable + + # A date range. + # Corresponds to the JSON property `dateRange` + # @return [Google::Apis::DisplayvideoV1::DateRange] + attr_accessor :date_range + + # Required. The type of the line item's flight dates. + # Corresponds to the JSON property `flightDateType` + # @return [String] + attr_accessor :flight_date_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @date_range = args[:date_range] if args.key?(:date_range) + @flight_date_type = args[:flight_date_type] if args.key?(:flight_date_type) + end + end + + # + class ListAdvertisersResponse + include Google::Apis::Core::Hashable + + # The list of advertisers. + # This list will be absent if empty. + # Corresponds to the JSON property `advertisers` + # @return [Array] + attr_accessor :advertisers + + # A token to retrieve the next page of results. + # Pass this value in the + # page_token + # field in the subsequent call to `ListAdvertisers` method to retrieve the + # next page of results. + # 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) + @advertisers = args[:advertisers] if args.key?(:advertisers) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # + class ListCampaignsResponse + include Google::Apis::Core::Hashable + + # The list of campaigns. + # This list will be absent if empty. + # Corresponds to the JSON property `campaigns` + # @return [Array] + attr_accessor :campaigns + + # A token to retrieve the next page of results. + # Pass this value in the page_token field + # in the subsequent call to `ListCampaigns` method to retrieve the next page + # of results. + # 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) + @campaigns = args[:campaigns] if args.key?(:campaigns) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # + class ListChannelsResponse + include Google::Apis::Core::Hashable + + # The list of channels. + # This list will be absent if empty. + # Corresponds to the JSON property `channels` + # @return [Array] + attr_accessor :channels + + # A token to retrieve the next page of results. + # Pass this value in the page_token field + # in the subsequent call to `ListChannels` method to retrieve the next page + # of results. + # 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) + @channels = args[:channels] if args.key?(:channels) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # + class ListCombinedAudiencesResponse + include Google::Apis::Core::Hashable + + # The list of combined audiences. + # This list will be absent if empty. + # Corresponds to the JSON property `combinedAudiences` + # @return [Array] + attr_accessor :combined_audiences + + # A token to retrieve the next page of results. + # Pass this value in the + # page_token + # field in the subsequent call to `ListCombinedAudiences` method to retrieve + # the next page of results. + # 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) + @combined_audiences = args[:combined_audiences] if args.key?(:combined_audiences) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # + class ListCreativesResponse + include Google::Apis::Core::Hashable + + # The list of creatives. + # This list will be absent if empty. + # Corresponds to the JSON property `creatives` + # @return [Array] + attr_accessor :creatives + + # A token to retrieve the next page of results. + # Pass this value in the page_token field + # in the subsequent call to `ListCreativesRequest` method to retrieve the + # next page of results. + # If this field is null, it means this is the last page. + # 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) + @creatives = args[:creatives] if args.key?(:creatives) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # + class ListCustomListsResponse + include Google::Apis::Core::Hashable + + # The list of custom lists. + # This list will be absent if empty. + # Corresponds to the JSON property `customLists` + # @return [Array] + attr_accessor :custom_lists + + # A token to retrieve the next page of results. + # Pass this value in the + # page_token + # field in the subsequent call to `ListCustomLists` method to retrieve the + # next page of results. + # 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) + @custom_lists = args[:custom_lists] if args.key?(:custom_lists) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # + class ListFirstAndThirdPartyAudiencesResponse + include Google::Apis::Core::Hashable + + # The list of first and third party audiences. Audience size properties will + # not be included. + # This list will be absent if empty. + # Corresponds to the JSON property `firstAndThirdPartyAudiences` + # @return [Array] + attr_accessor :first_and_third_party_audiences + + # A token to retrieve the next page of results. + # Pass this value in the + # page_token + # field in the subsequent call to `ListFirstAndThirdPartyAudiences` method to + # retrieve the next page of results. + # 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) + @first_and_third_party_audiences = args[:first_and_third_party_audiences] if args.key?(:first_and_third_party_audiences) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # + class ListGoogleAudiencesResponse + include Google::Apis::Core::Hashable + + # The list of Google audiences. + # This list will be absent if empty. + # Corresponds to the JSON property `googleAudiences` + # @return [Array] + attr_accessor :google_audiences + + # A token to retrieve the next page of results. + # Pass this value in the + # page_token + # field in the subsequent call to `ListGoogleAudiences` method to retrieve + # the next page of results. + # 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) + @google_audiences = args[:google_audiences] if args.key?(:google_audiences) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # + class ListInsertionOrdersResponse + include Google::Apis::Core::Hashable + + # The list of insertion orders. + # This list will be absent if empty. + # Corresponds to the JSON property `insertionOrders` + # @return [Array] + attr_accessor :insertion_orders + + # A token to retrieve the next page of results. + # Pass this value in the page_token + # field in the subsequent call to `ListInsertionOrders` method to retrieve + # the next page of results. + # 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) + @insertion_orders = args[:insertion_orders] if args.key?(:insertion_orders) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Response message for InventorySourceGroupService.ListInventorySourceGroups. + class ListInventorySourceGroupsResponse + include Google::Apis::Core::Hashable + + # The list of inventory source groups. + # This list will be absent if empty. + # Corresponds to the JSON property `inventorySourceGroups` + # @return [Array] + attr_accessor :inventory_source_groups + + # A token to retrieve the next page of results. + # Pass this value in the + # page_token + # field in the subsequent call to `ListInventorySourceGroups` method to + # retrieve the next page of results. + # 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) + @inventory_source_groups = args[:inventory_source_groups] if args.key?(:inventory_source_groups) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # + class ListInventorySourcesResponse + include Google::Apis::Core::Hashable + + # The list of inventory sources. + # This list will be absent if empty. + # Corresponds to the JSON property `inventorySources` + # @return [Array] + attr_accessor :inventory_sources + + # A token to retrieve the next page of results. + # Pass this value in the + # page_token + # field in the subsequent call to `ListInventorySources` method to retrieve + # the next page of results. + # 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) + @inventory_sources = args[:inventory_sources] if args.key?(:inventory_sources) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Response message for + # ListLineItemAssignedTargetingOptions. + class ListLineItemAssignedTargetingOptionsResponse + include Google::Apis::Core::Hashable + + # The list of assigned targeting options. + # This list will be absent if empty. + # Corresponds to the JSON property `assignedTargetingOptions` + # @return [Array] + attr_accessor :assigned_targeting_options + + # A token identifying the next page of results. This value should be + # specified as the + # pageToken in a + # subsequent ListLineItemAssignedTargetingOptionsRequest to fetch the + # next page of results. This token will be absent if there are no more + # assigned_targeting_options + # to return. + # 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) + @assigned_targeting_options = args[:assigned_targeting_options] if args.key?(:assigned_targeting_options) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # + class ListLineItemsResponse + include Google::Apis::Core::Hashable + + # The list of line items. + # This list will be absent if empty. + # Corresponds to the JSON property `lineItems` + # @return [Array] + attr_accessor :line_items + + # A token to retrieve the next page of results. + # Pass this value in the + # page_token + # field in the subsequent call to `ListLineItems` method to retrieve the + # next page of results. + # 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) + @line_items = args[:line_items] if args.key?(:line_items) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # + class ListLocationListsResponse + include Google::Apis::Core::Hashable + + # The list of location lists. + # This list will be absent if empty. + # Corresponds to the JSON property `locationLists` + # @return [Array] + attr_accessor :location_lists + + # A token to retrieve the next page of results. + # Pass this value in the + # page_token + # field in the subsequent call to `ListLocationLists` method to retrieve the + # next page of results. + # 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) + @location_lists = args[:location_lists] if args.key?(:location_lists) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Response message for NegativeKeywordListService.ListNegativeKeywordLists. + class ListNegativeKeywordListsResponse + include Google::Apis::Core::Hashable + + # The list of negative keyword lists. + # This list will be absent if empty. + # Corresponds to the JSON property `negativeKeywordLists` + # @return [Array] + attr_accessor :negative_keyword_lists + + # A token to retrieve the next page of results. + # Pass this value in the + # page_token + # field in the subsequent call to `ListNegativeKeywordLists` method to + # retrieve the next page of results. + # 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) + @negative_keyword_lists = args[:negative_keyword_lists] if args.key?(:negative_keyword_lists) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Response message for + # ListTargetingOptions. + class ListTargetingOptionsResponse + include Google::Apis::Core::Hashable + + # A token to retrieve the next page of results. + # Pass this value in the + # page_token + # field in the subsequent call to `ListTargetingOptions` method to retrieve + # the next page of results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # The list of targeting options. + # This list will be absent if empty. + # Corresponds to the JSON property `targetingOptions` + # @return [Array] + attr_accessor :targeting_options + + 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) + @targeting_options = args[:targeting_options] if args.key?(:targeting_options) + end + end + + # A list of locations used for targeting. + class LocationList + include Google::Apis::Core::Hashable + + # Required. Immutable. The unique ID of the advertiser the location list belongs + # to. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Required. The display name of the location list. + # Must be UTF-8 encoded with a maximum size of 240 bytes. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Output only. The unique ID of the location list. Assigned by the system. + # Corresponds to the JSON property `locationListId` + # @return [Fixnum] + attr_accessor :location_list_id + + # Required. Immutable. The type of location. All locations in the list will + # share this type. + # Corresponds to the JSON property `locationType` + # @return [String] + attr_accessor :location_type + + # Output only. The resource name of the location list. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @display_name = args[:display_name] if args.key?(:display_name) + @location_list_id = args[:location_list_id] if args.key?(:location_list_id) + @location_type = args[:location_type] if args.key?(:location_type) + @name = args[:name] if args.key?(:name) + end + end + + # Specifies how many days into the past to look when determining whether to + # record a conversion. + class LookbackWindow + include Google::Apis::Core::Hashable + + # Lookback window, in days, from the last time a given user clicked on one of + # your ads. + # Corresponds to the JSON property `clickDays` + # @return [Fixnum] + attr_accessor :click_days + + # Lookback window, in days, from the last time a given user viewed one of + # your ads. + # Corresponds to the JSON property `impressionDays` + # @return [Fixnum] + attr_accessor :impression_days + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @click_days = args[:click_days] if args.key?(:click_days) + @impression_days = args[:impression_days] if args.key?(:impression_days) + end + end + + # A strategy that automatically adjusts the bid to optimize a specified + # performance goal while spending the full budget. + class MaximizeSpendBidStrategy + include Google::Apis::Core::Hashable + + # The maximum average CPM that may be bid, in micros of the advertiser's + # currency. Must be greater than or equal to a billable unit of the given + # currency. + # For example, 1500000 represents 1.5 standard units of the currency. + # Corresponds to the JSON property `maxAverageCpmBidAmountMicros` + # @return [Fixnum] + attr_accessor :max_average_cpm_bid_amount_micros + + # Required. The type of the performance goal that the bidding strategy + # tries to minimize while spending the full budget. + # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for + # this strategy. + # Corresponds to the JSON property `performanceGoalType` + # @return [String] + attr_accessor :performance_goal_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @max_average_cpm_bid_amount_micros = args[:max_average_cpm_bid_amount_micros] if args.key?(:max_average_cpm_bid_amount_micros) + @performance_goal_type = args[:performance_goal_type] if args.key?(:performance_goal_type) + 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 + + # A list of negative keywords used for targeting. + class NegativeKeywordList + include Google::Apis::Core::Hashable + + # Output only. The unique ID of the advertiser the negative keyword list belongs + # to. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Required. The display name of the negative keyword list. + # Must be UTF-8 encoded with a maximum size of 255 bytes. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Output only. The resource name of the negative keyword list. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. The unique ID of the negative keyword list. Assigned by the + # system. + # Corresponds to the JSON property `negativeKeywordListId` + # @return [Fixnum] + attr_accessor :negative_keyword_list_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @display_name = args[:display_name] if args.key?(:display_name) + @name = args[:name] if args.key?(:name) + @negative_keyword_list_id = args[:negative_keyword_list_id] if args.key?(:negative_keyword_list_id) + end + end + + # Targeting details for negative keyword list. This will be populated in the + # details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. + class NegativeKeywordListAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Required. ID of the negative keyword list. Should refer to the + # negative_keyword_list_id + # field of a NegativeKeywordList resource. + # Corresponds to the JSON property `negativeKeywordListId` + # @return [Fixnum] + attr_accessor :negative_keyword_list_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @negative_keyword_list_id = args[:negative_keyword_list_id] if args.key?(:negative_keyword_list_id) + end + end + + # OBA Icon for a Creative + class ObaIcon + include Google::Apis::Core::Hashable + + # Required. The click tracking URL of the OBA icon. + # Only URLs of the following domains are allowed: + # * https://info.evidon.com + # * https://l.betrad.com + # Corresponds to the JSON property `clickTrackingUrl` + # @return [String] + attr_accessor :click_tracking_url + + # Dimensions. + # Corresponds to the JSON property `dimensions` + # @return [Google::Apis::DisplayvideoV1::Dimensions] + attr_accessor :dimensions + + # Required. The landing page URL of the OBA icon. + # Only URLs of the following domains are allowed: + # * https://info.evidon.com + # * https://l.betrad.com + # Corresponds to the JSON property `landingPageUrl` + # @return [String] + attr_accessor :landing_page_url + + # The position of the OBA icon on the creative. + # Corresponds to the JSON property `position` + # @return [String] + attr_accessor :position + + # The program of the OBA icon. For example: “AdChoices”. + # Corresponds to the JSON property `program` + # @return [String] + attr_accessor :program + + # The MIME type of the OBA icon resource. + # Corresponds to the JSON property `resourceMimeType` + # @return [String] + attr_accessor :resource_mime_type + + # The URL of the OBA icon resource. + # Corresponds to the JSON property `resourceUrl` + # @return [String] + attr_accessor :resource_url + + # Required. The view tracking URL of the OBA icon. + # Only URLs of the following domains are allowed: + # * https://info.evidon.com + # * https://l.betrad.com + # Corresponds to the JSON property `viewTrackingUrl` + # @return [String] + attr_accessor :view_tracking_url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @click_tracking_url = args[:click_tracking_url] if args.key?(:click_tracking_url) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @landing_page_url = args[:landing_page_url] if args.key?(:landing_page_url) + @position = args[:position] if args.key?(:position) + @program = args[:program] if args.key?(:program) + @resource_mime_type = args[:resource_mime_type] if args.key?(:resource_mime_type) + @resource_url = args[:resource_url] if args.key?(:resource_url) + @view_tracking_url = args[:view_tracking_url] if args.key?(:view_tracking_url) + end + end + + # On screen position targeting option details. This will be + # populated in the + # on_screen_position_details + # field when + # targeting_type is + # `TARGETING_TYPE_ON_SCREEN_POSITION`. + class OnScreenPositionAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The on screen position. + # Corresponds to the JSON property `onScreenPosition` + # @return [String] + attr_accessor :on_screen_position + + # Required. The targeting_option_id field when + # targeting_type is + # `TARGETING_TYPE_ON_SCREEN_POSITION`. + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @on_screen_position = args[:on_screen_position] if args.key?(:on_screen_position) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + end + end + + # Represents a targetable on screen position, which could be used by display + # and video ads. This will be populated in the + # on_screen_position_details + # field when + # targeting_type is + # `TARGETING_TYPE_ON_SCREEN_POSITION`. + class OnScreenPositionTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The on screen position. + # Corresponds to the JSON property `onScreenPosition` + # @return [String] + attr_accessor :on_screen_position + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @on_screen_position = args[:on_screen_position] if args.key?(:on_screen_position) + end + end + + # Assigned operating system targeting option details. This will be + # populated in the + # operating_system_details + # field when + # targeting_type is + # `TARGETING_TYPE_OPERATING_SYSTEM`. + class OperatingSystemAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The display name of the operating system. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Indicates if this option is being negatively targeted. + # Corresponds to the JSON property `negative` + # @return [Boolean] + attr_accessor :negative + alias_method :negative?, :negative + + # Required. The targeting option ID populated in + # targeting_option_id field when + # targeting_type is + # `TARGETING_TYPE_OPERATING_SYSTEM`. + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + @negative = args[:negative] if args.key?(:negative) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + end + end + + # Represents a targetable operating system. This will be populated in the + # operating_system_details field + # of a TargetingOption when + # targeting_type is + # `TARGETING_TYPE_OPERATING_SYSTEM`. + class OperatingSystemTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The display name of the operating system. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + end + end + # This resource represents a long-running operation that is the result of a # network API call. class Operation @@ -248,6 +5883,60 @@ module Google end end + # Settings that control the rate at which a budget is spent. + class Pacing + include Google::Apis::Core::Hashable + + # Maximum number of impressions to serve every day. + # Applicable when the budget is impression based. Must be greater than 0. + # Corresponds to the JSON property `dailyMaxImpressions` + # @return [Fixnum] + attr_accessor :daily_max_impressions + + # Maximum currency amount to spend every day in micros of + # advertiser's currency. + # Applicable when the budget is currency based. Must be greater than 0. + # For example, for 1.5 standard unit of the currency, set this field to + # 1500000. + # The value assigned will be rounded to whole billable units for the + # relevant currency by the following rules: any positive value less than a + # single billable unit will be rounded up to one billable unit and any + # value larger than a single billable unit will be rounded down to the + # nearest billable value. For example, if the currency's billable unit is + # 0.01, and this field is set to 10257770, it will round down to 10250000, + # a value of 10.25. If set to 505, it will round up to 10000, a value of + # 0.01. + # Corresponds to the JSON property `dailyMaxMicros` + # @return [Fixnum] + attr_accessor :daily_max_micros + + # Required. The time period in which the pacing budget will be spent. + # When automatic budget allocation is enabled at the insertion order via + # auto_budget_allocation, this + # field is output only and defaults to `PACING_PERIOD_FLIGHT`. + # Corresponds to the JSON property `pacingPeriod` + # @return [String] + attr_accessor :pacing_period + + # Required. The type of pacing that defines how the budget amount will be + # spent across the pacing_period. + # Corresponds to the JSON property `pacingType` + # @return [String] + attr_accessor :pacing_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @daily_max_impressions = args[:daily_max_impressions] if args.key?(:daily_max_impressions) + @daily_max_micros = args[:daily_max_micros] if args.key?(:daily_max_micros) + @pacing_period = args[:pacing_period] if args.key?(:pacing_period) + @pacing_type = args[:pacing_type] if args.key?(:pacing_type) + end + end + # A filtering option that filters on selected file types belonging to a chosen # set of filter entities. class ParentEntityFilter @@ -282,6 +5971,480 @@ module Google end end + # Details for assigned parental status targeting option. This will be + # populated in the details field of an AssignedTargetingOption when + # targeting_type is + # `TARTGETING_TYPE_PARENTAL_STATUS`. + class ParentalStatusAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The parental status of the audience. + # Corresponds to the JSON property `parentalStatus` + # @return [String] + attr_accessor :parental_status + + # Required. The targeting_option_id of a + # TargetingOption of type `TARGETING_TYPE_PARENTAL_STATUS`. + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @parental_status = args[:parental_status] if args.key?(:parental_status) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + end + end + + # Represents a targetable parental status. This will be populated in the + # parental_status_details field of a + # TargetingOption when targeting_type is + # `TARGETING_TYPE_PARENTAL_STATUS`. + class ParentalStatusTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The parental status of an audience. + # Corresponds to the JSON property `parentalStatus` + # @return [String] + attr_accessor :parental_status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @parental_status = args[:parental_status] if args.key?(:parental_status) + end + end + + # Settings that control a partner cost. + # A partner cost is any type of expense involved in running a campaign, other + # than the costs of purchasing impressions (which is called the media cost) + # and using third-party audience segment data (data fee). Some examples of + # partner costs include the fees for using DV360, a third-party ad server, + # or a third-party ad serving verification service. + class PartnerCost + include Google::Apis::Core::Hashable + + # Required. The type of the partner cost. + # Corresponds to the JSON property `costType` + # @return [String] + attr_accessor :cost_type + + # The CPM fee amount in micros of advertiser's currency. + # Applicable when the fee_type is + # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. + # For example, for 1.5 standard unit of the advertiser's currency, set + # this field to 1500000. + # Corresponds to the JSON property `feeAmount` + # @return [Fixnum] + attr_accessor :fee_amount + + # The media fee percentage in millis (1/1000 of a percent). + # Applicable when the fee_type is + # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. + # For example: 100 represents 0.1%. + # Corresponds to the JSON property `feePercentageMillis` + # @return [Fixnum] + attr_accessor :fee_percentage_millis + + # Required. The fee type for this partner cost. + # Corresponds to the JSON property `feeType` + # @return [String] + attr_accessor :fee_type + + # The invoice type for this partner cost. + # * Required when cost_type is one of: + # - `PARTNER_COST_TYPE_ADLOOX` + # - `PARTNER_COST_TYPE_DOUBLE_VERIFY` + # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. + # * Output only for other types. + # Corresponds to the JSON property `invoiceType` + # @return [String] + attr_accessor :invoice_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cost_type = args[:cost_type] if args.key?(:cost_type) + @fee_amount = args[:fee_amount] if args.key?(:fee_amount) + @fee_percentage_millis = args[:fee_percentage_millis] if args.key?(:fee_percentage_millis) + @fee_type = args[:fee_type] if args.key?(:fee_type) + @invoice_type = args[:invoice_type] if args.key?(:invoice_type) + end + end + + # Settings that control how partner revenue is calculated. + class PartnerRevenueModel + include Google::Apis::Core::Hashable + + # Required. The markup amount of the partner revenue model. + # Must be greater than or equal to 0. + # * When the markup_type is set to be + # `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM + # markup in micros of advertiser's currency. For example, 1500000 + # represents 1.5 standard units of the currency. + # * When the markup_type is set to be + # `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field + # represents the media cost percent markup in millis. For example, + # 100 represents 0.1% (decimal 0.001). + # * When the markup_type is set to be + # `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field + # represents the total media cost percent markup in millis. For example, + # 100 represents 0.1% (decimal 0.001). + # Corresponds to the JSON property `markupAmount` + # @return [Fixnum] + attr_accessor :markup_amount + + # Required. The markup type of the partner revenue model. + # Corresponds to the JSON property `markupType` + # @return [String] + attr_accessor :markup_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @markup_amount = args[:markup_amount] if args.key?(:markup_amount) + @markup_type = args[:markup_type] if args.key?(:markup_type) + end + end + + # Settings that control the performance goal of a campaign or insertion order. + class PerformanceGoal + include Google::Apis::Core::Hashable + + # The goal amount, in micros of the advertiser's currency. + # Applicable when + # performance_goal_type is one of: + # * `PERFORMANCE_GOAL_TYPE_CPM` + # * `PERFORMANCE_GOAL_TYPE_CPC` + # * `PERFORMANCE_GOAL_TYPE_CPA` + # * `PERFORMANCE_GOAL_TYPE_CPIAVC` + # For example 1500000 represents 1.5 standard units of the currency. + # Corresponds to the JSON property `performanceGoalAmountMicros` + # @return [Fixnum] + attr_accessor :performance_goal_amount_micros + + # The decimal representation of the goal percentage in micros. + # Applicable when + # performance_goal_type is one of: + # * `PERFORMANCE_GOAL_TYPE_CTR` + # * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` + # For example, 70000 represents 7% (decimal 0.07). + # Corresponds to the JSON property `performanceGoalPercentageMicros` + # @return [Fixnum] + attr_accessor :performance_goal_percentage_micros + + # A key performance indicator (KPI) string, which can be empty. + # Must be UTF-8 encoded with a length of no more than 100 characters. + # Applicable when + # performance_goal_type is set to + # `PERFORMANCE_GOAL_TYPE_OTHER`. + # Corresponds to the JSON property `performanceGoalString` + # @return [String] + attr_accessor :performance_goal_string + + # Required. The type of the performance goal. + # Corresponds to the JSON property `performanceGoalType` + # @return [String] + attr_accessor :performance_goal_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @performance_goal_amount_micros = args[:performance_goal_amount_micros] if args.key?(:performance_goal_amount_micros) + @performance_goal_percentage_micros = args[:performance_goal_percentage_micros] if args.key?(:performance_goal_percentage_micros) + @performance_goal_string = args[:performance_goal_string] if args.key?(:performance_goal_string) + @performance_goal_type = args[:performance_goal_type] if args.key?(:performance_goal_type) + end + end + + # A strategy that automatically adjusts the bid to meet or beat a specified + # performance goal. + class PerformanceGoalBidStrategy + include Google::Apis::Core::Hashable + + # The maximum average CPM that may be bid, in micros of the advertiser's + # currency. Must be greater than or equal to a billable unit of the given + # currency. Not applicable when + # performance_goal_type + # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. + # For example, 1500000 represents 1.5 standard units of the currency. + # Corresponds to the JSON property `maxAverageCpmBidAmountMicros` + # @return [Fixnum] + attr_accessor :max_average_cpm_bid_amount_micros + + # Required. The performance goal the bidding strategy will attempt to + # meet or beat, in micros of the advertiser's currency. + # Must be greater than or equal to a billable unit of the given currency and + # smaller or equal to upper bounds. Each + # performance_goal_type + # has its upper bound: + # * when + # performance_goal_type + # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, + # upper bound is 10000.00 USD. + # * when + # performance_goal_type + # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, + # upper bound is 1000.00 USD. + # * when + # performance_goal_type + # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is + # 1000.00 USD. + # Example: If set to + # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will + # be based on the probability that each available impression will be + # viewable. For example, if viewable CPM target is $2 and an impression is + # 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). + # For example, 1500000 represents 1.5 standard units of the currency. + # Corresponds to the JSON property `performanceGoalAmountMicros` + # @return [Fixnum] + attr_accessor :performance_goal_amount_micros + + # Required. The type of the performance goal that the bidding strategy + # will try to meet or beat. + # For line item level usage, the value must be one of: + # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` + # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` + # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. + # Corresponds to the JSON property `performanceGoalType` + # @return [String] + attr_accessor :performance_goal_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @max_average_cpm_bid_amount_micros = args[:max_average_cpm_bid_amount_micros] if args.key?(:max_average_cpm_bid_amount_micros) + @performance_goal_amount_micros = args[:performance_goal_amount_micros] if args.key?(:performance_goal_amount_micros) + @performance_goal_type = args[:performance_goal_type] if args.key?(:performance_goal_type) + end + end + + # Targeting details for proximity location list. This will be + # populated in the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. + class ProximityLocationListAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Required. ID of the proximity location list. Should refer to the + # location_list_id field of a + # LocationList resource whose type is + # `TARGETING_LOCATION_TYPE_PROXIMITY`. + # Corresponds to the JSON property `proximityLocationListId` + # @return [Fixnum] + attr_accessor :proximity_location_list_id + + # Required. Radius range for proximity location list. + # This represents the size of the area around a chosen location that will be + # targeted. + # `All` proximity location targeting under a single line item must have the + # same radius range value. Set this value to match any existing targeting. + # If updated, this field will change the radius range for all proximity + # targeting under the line item. + # Corresponds to the JSON property `proximityRadiusRange` + # @return [String] + attr_accessor :proximity_radius_range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @proximity_location_list_id = args[:proximity_location_list_id] if args.key?(:proximity_location_list_id) + @proximity_radius_range = args[:proximity_radius_range] if args.key?(:proximity_radius_range) + end + end + + # Publisher review status for the creative. + class PublisherReviewStatus + include Google::Apis::Core::Hashable + + # The publisher reviewing the creative. + # Corresponds to the JSON property `publisherName` + # @return [String] + attr_accessor :publisher_name + + # Status of the publisher review. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @publisher_name = args[:publisher_name] if args.key?(:publisher_name) + @status = args[:status] if args.key?(:status) + end + end + + # The rate related settings of the inventory source. + class RateDetails + include Google::Apis::Core::Hashable + + # The rate type. + # Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, + # `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and + # `INVENTORY_SOURCE_RATE_TYPE_CPD`. + # Corresponds to the JSON property `inventorySourceRateType` + # @return [String] + attr_accessor :inventory_source_rate_type + + # Represents an amount of money with its currency type. + # Corresponds to the JSON property `minimumSpend` + # @return [Google::Apis::DisplayvideoV1::Money] + attr_accessor :minimum_spend + + # Represents an amount of money with its currency type. + # Corresponds to the JSON property `rate` + # @return [Google::Apis::DisplayvideoV1::Money] + attr_accessor :rate + + # Required for guaranteed inventory sources. + # The number of impressions guaranteed by the seller. + # Corresponds to the JSON property `unitsPurchased` + # @return [Fixnum] + attr_accessor :units_purchased + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @inventory_source_rate_type = args[:inventory_source_rate_type] if args.key?(:inventory_source_rate_type) + @minimum_spend = args[:minimum_spend] if args.key?(:minimum_spend) + @rate = args[:rate] if args.key?(:rate) + @units_purchased = args[:units_purchased] if args.key?(:units_purchased) + end + end + + # Targeting details for regional location list. This will be + # populated in the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. + class RegionalLocationListAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Indicates if this option is being negatively targeted. + # Corresponds to the JSON property `negative` + # @return [Boolean] + attr_accessor :negative + alias_method :negative?, :negative + + # Required. ID of the regional location list. Should refer to the + # location_list_id field of a + # LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. + # Corresponds to the JSON property `regionalLocationListId` + # @return [Fixnum] + attr_accessor :regional_location_list_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @negative = args[:negative] if args.key?(:negative) + @regional_location_list_id = args[:regional_location_list_id] if args.key?(:regional_location_list_id) + end + end + + # Review statuses for the creative. + class ReviewStatusInfo + include Google::Apis::Core::Hashable + + # Represents the basic approval needed for a creative to begin serving. + # Summary of + # creative_and_landing_page_review_status + # and + # content_and_policy_review_status. + # Corresponds to the JSON property `approvalStatus` + # @return [String] + attr_accessor :approval_status + + # Content and policy review status for the creative. + # Corresponds to the JSON property `contentAndPolicyReviewStatus` + # @return [String] + attr_accessor :content_and_policy_review_status + + # Creative and landing page review status for the creative. + # Corresponds to the JSON property `creativeAndLandingPageReviewStatus` + # @return [String] + attr_accessor :creative_and_landing_page_review_status + + # Exchange review statuses for the creative. + # Corresponds to the JSON property `exchangeReviewStatuses` + # @return [Array] + attr_accessor :exchange_review_statuses + + # Publisher review statuses for the creative. + # Corresponds to the JSON property `publisherReviewStatuses` + # @return [Array] + attr_accessor :publisher_review_statuses + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @approval_status = args[:approval_status] if args.key?(:approval_status) + @content_and_policy_review_status = args[:content_and_policy_review_status] if args.key?(:content_and_policy_review_status) + @creative_and_landing_page_review_status = args[:creative_and_landing_page_review_status] if args.key?(:creative_and_landing_page_review_status) + @exchange_review_statuses = args[:exchange_review_statuses] if args.key?(:exchange_review_statuses) + @publisher_review_statuses = args[:publisher_review_statuses] if args.key?(:publisher_review_statuses) + end + end + + # Structured Data File (SDF) related settings. + class SdfConfig + include Google::Apis::Core::Hashable + + # An administrator email address to which the SDF processing status reports + # will be sent. + # Corresponds to the JSON property `adminEmail` + # @return [String] + attr_accessor :admin_email + + # Required. The version of SDF being used. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @admin_email = args[:admin_email] if args.key?(:admin_email) + @version = args[:version] if args.key?(:version) + end + end + # Type for the response returned # by [SdfDownloadTaskService.CreateSdfDownloadTask]. class SdfDownloadTask @@ -339,6 +6502,58 @@ module Google end end + # Targeting details for sensitive category. This will be populated in the + # details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. + class SensitiveCategoryAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Required. ID of the sensitive category to be EXCLUDED. + # Corresponds to the JSON property `excludedTargetingOptionId` + # @return [String] + attr_accessor :excluded_targeting_option_id + + # Output only. An enum for the DV360 Sensitive category content classifier. + # Corresponds to the JSON property `sensitiveCategory` + # @return [String] + attr_accessor :sensitive_category + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @excluded_targeting_option_id = args[:excluded_targeting_option_id] if args.key?(:excluded_targeting_option_id) + @sensitive_category = args[:sensitive_category] if args.key?(:sensitive_category) + end + end + + # Represents a targetable sensitive category. This will be + # populated in the + # sensitive_category_details + # field of the TargetingOption when + # targeting_type is + # `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. + class SensitiveCategoryTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. An enum for the DV360 Sensitive category content classifier. + # Corresponds to the JSON property `sensitiveCategory` + # @return [String] + attr_accessor :sensitive_category + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @sensitive_category = args[:sensitive_category] if args.key?(:sensitive_category) + end + end + # 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). Each `Status` message contains @@ -377,6 +6592,787 @@ module Google @message = args[:message] if args.key?(:message) end end + + # Details for assigned sub-exchange targeting option. This will be populated in + # the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_SUB_EXCHANGE`. + class SubExchangeAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Required. The targeting_option_id of a + # TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`. + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + end + end + + # Represents a targetable sub-exchange. This will be populated in the + # sub_exchange_details field + # of a TargetingOption when + # targeting_type is + # `TARGETING_TYPE_SUB_EXCHANGE`. + class SubExchangeTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The display name of the sub-exchange. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + end + end + + # Represents a single targeting option, which is a targetable concept in + # DV360. + class TargetingOption + include Google::Apis::Core::Hashable + + # Represents a targetable age range. This will be populated in the + # age_range_details field when + # targeting_type is + # `TARGETING_TYPE_AGE_RANGE`. + # Corresponds to the JSON property `ageRangeDetails` + # @return [Google::Apis::DisplayvideoV1::AgeRangeTargetingOptionDetails] + attr_accessor :age_range_details + + # Represents a targetable collection of apps. A collection lets you target + # dynamic groups of related apps that are maintained by the platform, for + # example `All Apps/Google Play/Games`. This will be populated in the + # app_category_details field when + # targeting_type is + # `TARGETING_TYPE_APP_CATEGORY`. + # Corresponds to the JSON property `appCategoryDetails` + # @return [Google::Apis::DisplayvideoV1::AppCategoryTargetingOptionDetails] + attr_accessor :app_category_details + + # Represents a targetable authorized seller status. This will be populated in + # the + # authorized_seller_status_details + # field when targeting_type is + # `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. + # Corresponds to the JSON property `authorizedSellerStatusDetails` + # @return [Google::Apis::DisplayvideoV1::AuthorizedSellerStatusTargetingOptionDetails] + attr_accessor :authorized_seller_status_details + + # Represents a targetable browser. This will be populated in the + # browser_details field when + # targeting_type is + # `TARGETING_TYPE_BROWSER`. + # Corresponds to the JSON property `browserDetails` + # @return [Google::Apis::DisplayvideoV1::BrowserTargetingOptionDetails] + attr_accessor :browser_details + + # Represents a targetable carrier or ISP. This will be populated in the + # carrier_and_isp_details field of + # a TargetingOption when + # targeting_type is + # `TARGETING_TYPE_CARRIER_AND_ISP`. + # Corresponds to the JSON property `carrierAndIspDetails` + # @return [Google::Apis::DisplayvideoV1::CarrierAndIspTargetingOptionDetails] + attr_accessor :carrier_and_isp_details + + # Represents a targetable category. This will be populated in the + # category_details field of a + # TargetingOption when targeting_type is + # `TARGETING_TYPE_CATEGORY`. + # Corresponds to the JSON property `categoryDetails` + # @return [Google::Apis::DisplayvideoV1::CategoryTargetingOptionDetails] + attr_accessor :category_details + + # Represents a targetable content instream position, which could be used by + # video and audio ads. This will be populated in the + # content_instream_position_details + # field when targeting_type is + # `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. + # Corresponds to the JSON property `contentInstreamPositionDetails` + # @return [Google::Apis::DisplayvideoV1::ContentInstreamPositionTargetingOptionDetails] + attr_accessor :content_instream_position_details + + # Represents a targetable content outstream position, which could be used by + # display and video ads. This will be populated in the + # content_outstream_position_details + # field when targeting_type is + # `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. + # Corresponds to the JSON property `contentOutstreamPositionDetails` + # @return [Google::Apis::DisplayvideoV1::ContentOutstreamPositionTargetingOptionDetails] + attr_accessor :content_outstream_position_details + + # Represents a targetable device make and model. This will be populated in the + # device_make_model_details + # field of a TargetingOption when + # targeting_type is + # `TARGETING_TYPE_DEVICE_MAKE_MODEL`. + # Corresponds to the JSON property `deviceMakeModelDetails` + # @return [Google::Apis::DisplayvideoV1::DeviceMakeModelTargetingOptionDetails] + attr_accessor :device_make_model_details + + # Represents a targetable device type. This will be populated in the + # device_type_details field of a + # TargetingOption when targeting_type is + # `TARGETING_TYPE_DEVICE_TYPE`. + # Corresponds to the JSON property `deviceTypeDetails` + # @return [Google::Apis::DisplayvideoV1::DeviceTypeTargetingOptionDetails] + attr_accessor :device_type_details + + # Represents a targetable digital content label rating tier. This will be + # populated in the + # digital_content_label_details + # field of the TargetingOption when + # targeting_type is + # `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. + # Corresponds to the JSON property `digitalContentLabelDetails` + # @return [Google::Apis::DisplayvideoV1::DigitalContentLabelTargetingOptionDetails] + attr_accessor :digital_content_label_details + + # Represents a targetable environment. This will be populated in the + # environment_details field of a + # TargetingOption when targeting_type is + # `TARGETING_TYPE_ENVIRONMENT`. + # Corresponds to the JSON property `environmentDetails` + # @return [Google::Apis::DisplayvideoV1::EnvironmentTargetingOptionDetails] + attr_accessor :environment_details + + # Represents a targetable exchange. This will be populated in the + # exchange_details field + # of a TargetingOption when + # targeting_type is + # `TARGETING_TYPE_EXCHANGE`. + # Corresponds to the JSON property `exchangeDetails` + # @return [Google::Apis::DisplayvideoV1::ExchangeTargetingOptionDetails] + attr_accessor :exchange_details + + # Represents a targetable gender. This will be populated in the + # gender_details field of a TargetingOption + # when targeting_type is + # `TARGETING_TYPE_GENDER`. + # Corresponds to the JSON property `genderDetails` + # @return [Google::Apis::DisplayvideoV1::GenderTargetingOptionDetails] + attr_accessor :gender_details + + # Represents a targetable geographic region. This will be populated in the + # geo_region_details field when + # targeting_type is + # `TARGETING_TYPE_GEO_REGION`. + # Corresponds to the JSON property `geoRegionDetails` + # @return [Google::Apis::DisplayvideoV1::GeoRegionTargetingOptionDetails] + attr_accessor :geo_region_details + + # Represents a targetable household income. This will be populated in the + # household_income_details field of + # a TargetingOption when targeting_type is + # `TARGETING_TYPE_HOUSEHOLD_INCOME`. + # Corresponds to the JSON property `householdIncomeDetails` + # @return [Google::Apis::DisplayvideoV1::HouseholdIncomeTargetingOptionDetails] + attr_accessor :household_income_details + + # Represents a targetable language. This will be populated in the + # language_details field when + # targeting_type is + # `TARGETING_TYPE_LANGUAGE`. + # Corresponds to the JSON property `languageDetails` + # @return [Google::Apis::DisplayvideoV1::LanguageTargetingOptionDetails] + attr_accessor :language_details + + # Output only. The resource name for this targeting option. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Represents a targetable on screen position, which could be used by display + # and video ads. This will be populated in the + # on_screen_position_details + # field when + # targeting_type is + # `TARGETING_TYPE_ON_SCREEN_POSITION`. + # Corresponds to the JSON property `onScreenPositionDetails` + # @return [Google::Apis::DisplayvideoV1::OnScreenPositionTargetingOptionDetails] + attr_accessor :on_screen_position_details + + # Represents a targetable operating system. This will be populated in the + # operating_system_details field + # of a TargetingOption when + # targeting_type is + # `TARGETING_TYPE_OPERATING_SYSTEM`. + # Corresponds to the JSON property `operatingSystemDetails` + # @return [Google::Apis::DisplayvideoV1::OperatingSystemTargetingOptionDetails] + attr_accessor :operating_system_details + + # Represents a targetable parental status. This will be populated in the + # parental_status_details field of a + # TargetingOption when targeting_type is + # `TARGETING_TYPE_PARENTAL_STATUS`. + # Corresponds to the JSON property `parentalStatusDetails` + # @return [Google::Apis::DisplayvideoV1::ParentalStatusTargetingOptionDetails] + attr_accessor :parental_status_details + + # Represents a targetable sensitive category. This will be + # populated in the + # sensitive_category_details + # field of the TargetingOption when + # targeting_type is + # `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. + # Corresponds to the JSON property `sensitiveCategoryDetails` + # @return [Google::Apis::DisplayvideoV1::SensitiveCategoryTargetingOptionDetails] + attr_accessor :sensitive_category_details + + # Represents a targetable sub-exchange. This will be populated in the + # sub_exchange_details field + # of a TargetingOption when + # targeting_type is + # `TARGETING_TYPE_SUB_EXCHANGE`. + # Corresponds to the JSON property `subExchangeDetails` + # @return [Google::Apis::DisplayvideoV1::SubExchangeTargetingOptionDetails] + attr_accessor :sub_exchange_details + + # Output only. A unique identifier for this targeting option. The tuple + # ``targeting_type`, `targeting_option_id`` will be unique. + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + # Output only. The type of this targeting option. + # Corresponds to the JSON property `targetingType` + # @return [String] + attr_accessor :targeting_type + + # Represents a targetable user rewarded content status for video ads only. This + # will be populated in the + # user_rewarded_content_details + # field when + # targeting_type is + # `TARGETING_TYPE_USER_REWARDED_CONTENT`. + # Corresponds to the JSON property `userRewardedContentDetails` + # @return [Google::Apis::DisplayvideoV1::UserRewardedContentTargetingOptionDetails] + attr_accessor :user_rewarded_content_details + + # Represents a targetable video player size. This will be populated in the + # video_player_size_details + # field when targeting_type is + # `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. + # Corresponds to the JSON property `videoPlayerSizeDetails` + # @return [Google::Apis::DisplayvideoV1::VideoPlayerSizeTargetingOptionDetails] + attr_accessor :video_player_size_details + + # Represents a targetable viewability. This will be populated in the + # viewability_details field of a + # TargetingOption when targeting_type is + # `TARGETING_TYPE_VIEWABILITY`. + # Corresponds to the JSON property `viewabilityDetails` + # @return [Google::Apis::DisplayvideoV1::ViewabilityTargetingOptionDetails] + attr_accessor :viewability_details + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @age_range_details = args[:age_range_details] if args.key?(:age_range_details) + @app_category_details = args[:app_category_details] if args.key?(:app_category_details) + @authorized_seller_status_details = args[:authorized_seller_status_details] if args.key?(:authorized_seller_status_details) + @browser_details = args[:browser_details] if args.key?(:browser_details) + @carrier_and_isp_details = args[:carrier_and_isp_details] if args.key?(:carrier_and_isp_details) + @category_details = args[:category_details] if args.key?(:category_details) + @content_instream_position_details = args[:content_instream_position_details] if args.key?(:content_instream_position_details) + @content_outstream_position_details = args[:content_outstream_position_details] if args.key?(:content_outstream_position_details) + @device_make_model_details = args[:device_make_model_details] if args.key?(:device_make_model_details) + @device_type_details = args[:device_type_details] if args.key?(:device_type_details) + @digital_content_label_details = args[:digital_content_label_details] if args.key?(:digital_content_label_details) + @environment_details = args[:environment_details] if args.key?(:environment_details) + @exchange_details = args[:exchange_details] if args.key?(:exchange_details) + @gender_details = args[:gender_details] if args.key?(:gender_details) + @geo_region_details = args[:geo_region_details] if args.key?(:geo_region_details) + @household_income_details = args[:household_income_details] if args.key?(:household_income_details) + @language_details = args[:language_details] if args.key?(:language_details) + @name = args[:name] if args.key?(:name) + @on_screen_position_details = args[:on_screen_position_details] if args.key?(:on_screen_position_details) + @operating_system_details = args[:operating_system_details] if args.key?(:operating_system_details) + @parental_status_details = args[:parental_status_details] if args.key?(:parental_status_details) + @sensitive_category_details = args[:sensitive_category_details] if args.key?(:sensitive_category_details) + @sub_exchange_details = args[:sub_exchange_details] if args.key?(:sub_exchange_details) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + @targeting_type = args[:targeting_type] if args.key?(:targeting_type) + @user_rewarded_content_details = args[:user_rewarded_content_details] if args.key?(:user_rewarded_content_details) + @video_player_size_details = args[:video_player_size_details] if args.key?(:video_player_size_details) + @viewability_details = args[:viewability_details] if args.key?(:viewability_details) + end + end + + # Settings for advertisers that use third-party ad servers only. + class ThirdPartyOnlyConfig + include Google::Apis::Core::Hashable + + # Whether or not order ID reporting for pixels is enabled. + # This value cannot be changed once set to `true`. + # Corresponds to the JSON property `pixelOrderIdReportingEnabled` + # @return [Boolean] + attr_accessor :pixel_order_id_reporting_enabled + alias_method :pixel_order_id_reporting_enabled?, :pixel_order_id_reporting_enabled + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @pixel_order_id_reporting_enabled = args[:pixel_order_id_reporting_enabled] if args.key?(:pixel_order_id_reporting_enabled) + end + end + + # Tracking URLs from third parties to track interactions with an audio or a + # video creative. + class ThirdPartyUrl + include Google::Apis::Core::Hashable + + # The type of interaction needs to be tracked by the tracking URL + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # Tracking URL used to track the interaction. + # Provide a URL with optional path or query string, beginning with `https:`. + # For example, https://www.example.com/path + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @type = args[:type] if args.key?(:type) + @url = args[:url] if args.key?(:url) + end + end + + # Assigned third party verifier targeting option details. This will be + # populated in the details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. + class ThirdPartyVerifierAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Details of Adloox settings. + # Corresponds to the JSON property `adloox` + # @return [Google::Apis::DisplayvideoV1::Adloox] + attr_accessor :adloox + + # Details of DoubleVerify settings. + # Corresponds to the JSON property `doubleVerify` + # @return [Google::Apis::DisplayvideoV1::DoubleVerify] + attr_accessor :double_verify + + # Details of Integral Ad Science settings. + # Corresponds to the JSON property `integralAdScience` + # @return [Google::Apis::DisplayvideoV1::IntegralAdScience] + attr_accessor :integral_ad_science + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @adloox = args[:adloox] if args.key?(:adloox) + @double_verify = args[:double_verify] if args.key?(:double_verify) + @integral_ad_science = args[:integral_ad_science] if args.key?(:integral_ad_science) + end + end + + # A time range. + class TimeRange + include Google::Apis::Core::Hashable + + # Required. The upper bound of a time range, inclusive. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # Required. The lower bound of a time range, inclusive. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end_time = args[:end_time] if args.key?(:end_time) + @start_time = args[:start_time] if args.key?(:start_time) + end + end + + # Timer event of the creative. + class TimerEvent + include Google::Apis::Core::Hashable + + # Required. The name of the timer event. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Required. The name used to identify this timer event in reports. + # Corresponds to the JSON property `reportingName` + # @return [String] + attr_accessor :reporting_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @reporting_name = args[:reporting_name] if args.key?(:reporting_name) + end + end + + # Settings that control the behavior of a single Floodlight activity config. + class TrackingFloodlightActivityConfig + include Google::Apis::Core::Hashable + + # Required. The ID of the Floodlight activity. + # Corresponds to the JSON property `floodlightActivityId` + # @return [Fixnum] + attr_accessor :floodlight_activity_id + + # Required. The number of days after an ad has been clicked in which a + # conversion may be counted. + # Must be between 0 and 90 inclusive. + # Corresponds to the JSON property `postClickLookbackWindowDays` + # @return [Fixnum] + attr_accessor :post_click_lookback_window_days + + # Required. The number of days after an ad has been viewed in which a + # conversion may be counted. + # Must be between 0 and 90 inclusive. + # Corresponds to the JSON property `postViewLookbackWindowDays` + # @return [Fixnum] + attr_accessor :post_view_lookback_window_days + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @floodlight_activity_id = args[:floodlight_activity_id] if args.key?(:floodlight_activity_id) + @post_click_lookback_window_days = args[:post_click_lookback_window_days] if args.key?(:post_click_lookback_window_days) + @post_view_lookback_window_days = args[:post_view_lookback_window_days] if args.key?(:post_view_lookback_window_days) + end + end + + # Represents information about the transcoded audio or video file. + class Transcode + include Google::Apis::Core::Hashable + + # The bit rate for the audio stream of the transcoded video, or the bit rate + # for the transcoded audio, in kilobits per second. + # Corresponds to the JSON property `audioBitRateKbps` + # @return [Fixnum] + attr_accessor :audio_bit_rate_kbps + + # The sample rate for the audio stream of the transcoded video, or the sample + # rate for the transcoded audio, in hertz. + # Corresponds to the JSON property `audioSampleRateHz` + # @return [Fixnum] + attr_accessor :audio_sample_rate_hz + + # The transcoding bit rate of the transcoded video, in kilobits per second. + # Corresponds to the JSON property `bitRateKbps` + # @return [Fixnum] + attr_accessor :bit_rate_kbps + + # Dimensions. + # Corresponds to the JSON property `dimensions` + # @return [Google::Apis::DisplayvideoV1::Dimensions] + attr_accessor :dimensions + + # The size of the transcoded file, in bytes. + # Corresponds to the JSON property `fileSizeBytes` + # @return [Fixnum] + attr_accessor :file_size_bytes + + # The frame rate of the transcoded video, in frames per second. + # Corresponds to the JSON property `frameRate` + # @return [Float] + attr_accessor :frame_rate + + # The MIME type of the transcoded file. + # Corresponds to the JSON property `mimeType` + # @return [String] + attr_accessor :mime_type + + # The name of the transcoded file. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Indicates if the transcoding was successful. + # Corresponds to the JSON property `transcoded` + # @return [Boolean] + attr_accessor :transcoded + alias_method :transcoded?, :transcoded + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @audio_bit_rate_kbps = args[:audio_bit_rate_kbps] if args.key?(:audio_bit_rate_kbps) + @audio_sample_rate_hz = args[:audio_sample_rate_hz] if args.key?(:audio_sample_rate_hz) + @bit_rate_kbps = args[:bit_rate_kbps] if args.key?(:bit_rate_kbps) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @file_size_bytes = args[:file_size_bytes] if args.key?(:file_size_bytes) + @frame_rate = args[:frame_rate] if args.key?(:frame_rate) + @mime_type = args[:mime_type] if args.key?(:mime_type) + @name = args[:name] if args.key?(:name) + @transcoded = args[:transcoded] if args.key?(:transcoded) + end + end + + # A creative identifier provided by a registry that is unique across all + # platforms. This is part of the VAST 4.0 standard. + class UniversalAdId + include Google::Apis::Core::Hashable + + # The unique creative identifier. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # The registry provides unique creative identifiers. + # Corresponds to the JSON property `registry` + # @return [String] + attr_accessor :registry + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @registry = args[:registry] if args.key?(:registry) + end + end + + # Details for assigned URL targeting option. This will be populated in the + # details field of an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_URL`. + class UrlAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Indicates if this option is being negatively targeted. + # Corresponds to the JSON property `negative` + # @return [Boolean] + attr_accessor :negative + alias_method :negative?, :negative + + # Required. The URL, for example `example.com`. + # DV360 supports two levels of subdirectory targeting, for example + # `www.example.com/one-subdirectory-level/second-level`, and five levels of + # subdomain targeting, for example `five.four.three.two.one.example.com`. + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @negative = args[:negative] if args.key?(:negative) + @url = args[:url] if args.key?(:url) + end + end + + # User rewarded content targeting option details. This will be populated in + # the + # user_rewarded_content_details + # field when + # targeting_type is + # `TARGETING_TYPE_USER_REWARDED_CONTENT`. + class UserRewardedContentAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Required. The targeting_option_id field when + # targeting_type is + # `TARGETING_TYPE_USER_REWARDED_CONTENT`. + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + # Output only. User rewarded content status for video ads. + # Corresponds to the JSON property `userRewardedContent` + # @return [String] + attr_accessor :user_rewarded_content + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + @user_rewarded_content = args[:user_rewarded_content] if args.key?(:user_rewarded_content) + end + end + + # Represents a targetable user rewarded content status for video ads only. This + # will be populated in the + # user_rewarded_content_details + # field when + # targeting_type is + # `TARGETING_TYPE_USER_REWARDED_CONTENT`. + class UserRewardedContentTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. User rewarded content status for video ads. + # Corresponds to the JSON property `userRewardedContent` + # @return [String] + attr_accessor :user_rewarded_content + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @user_rewarded_content = args[:user_rewarded_content] if args.key?(:user_rewarded_content) + end + end + + # Video player size targeting option details. This will be populated in the + # video_player_size_details + # field when targeting_type is + # `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. + # Explicitly targeting all options is not supported. Remove all video player + # size targeting options to achieve this effect. + class VideoPlayerSizeAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Required. The targeting_option_id field when + # targeting_type is + # `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + # Output only. The video player size. + # Corresponds to the JSON property `videoPlayerSize` + # @return [String] + attr_accessor :video_player_size + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + @video_player_size = args[:video_player_size] if args.key?(:video_player_size) + end + end + + # Represents a targetable video player size. This will be populated in the + # video_player_size_details + # field when targeting_type is + # `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. + class VideoPlayerSizeTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The video player size. + # Corresponds to the JSON property `videoPlayerSize` + # @return [String] + attr_accessor :video_player_size + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @video_player_size = args[:video_player_size] if args.key?(:video_player_size) + end + end + + # Assigned viewability targeting option details. This will be populated in the + # viewability_details field of + # an AssignedTargetingOption when + # targeting_type is + # `TARGETING_TYPE_VIEWABILITY`. + class ViewabilityAssignedTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Required. The targeting_option_id of a + # TargetingOption of type `TARGETING_TYPE_VIEWABILITY` (e.g., "509010" + # for targeting the `VIEWABILITY_10_PERCENT_OR_MORE` option). + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + # Output only. The predicted viewability percentage. + # Corresponds to the JSON property `viewability` + # @return [String] + attr_accessor :viewability + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + @viewability = args[:viewability] if args.key?(:viewability) + end + end + + # Represents a targetable viewability. This will be populated in the + # viewability_details field of a + # TargetingOption when targeting_type is + # `TARGETING_TYPE_VIEWABILITY`. + class ViewabilityTargetingOptionDetails + include Google::Apis::Core::Hashable + + # Output only. The predicted viewability percentage. + # Corresponds to the JSON property `viewability` + # @return [String] + attr_accessor :viewability + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @viewability = args[:viewability] if args.key?(:viewability) + end + end end end end diff --git a/generated/google/apis/displayvideo_v1/representations.rb b/generated/google/apis/displayvideo_v1/representations.rb index 5a26bc950..b77103aea 100644 --- a/generated/google/apis/displayvideo_v1/representations.rb +++ b/generated/google/apis/displayvideo_v1/representations.rb @@ -22,42 +22,948 @@ module Google module Apis module DisplayvideoV1 + class ActiveViewVideoViewabilityMetricConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Adloox + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Advertiser + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AdvertiserAdServerConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AdvertiserCreativeConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AdvertiserDataAccessConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AdvertiserGeneralConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AdvertiserSdfConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AgeRangeAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AgeRangeTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AppAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AppCategoryAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AppCategoryTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Asset + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AssetAssociation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AssignedTargetingOption + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AudienceGroupAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AudioVideoOffset + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuthorizedSellerStatusAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuthorizedSellerStatusTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BiddingStrategy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BrowserAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BrowserTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BulkEditLineItemAssignedTargetingOptionsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BulkEditLineItemAssignedTargetingOptionsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BulkListLineItemAssignedTargetingOptionsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Campaign + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CampaignFlight + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CampaignGoal + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CarrierAndIspAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CarrierAndIspTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CategoryAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CategoryTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Channel + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ChannelAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CmHybridConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CmTrackingAd + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CombinedAudience + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CombinedAudienceGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CombinedAudienceTargetingSetting + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ContentInstreamPositionAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ContentInstreamPositionTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ContentOutstreamPositionAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ContentOutstreamPositionTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ConversionCountingConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CounterEvent + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreateAssetRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreateAssetResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreateAssignedTargetingOptionsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class CreateSdfDownloadTaskRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class Creative + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomList + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomListGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomListTargetingSetting + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Date + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DateRange + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DayAndTimeAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeleteAssignedTargetingOptionsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeviceMakeModelAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeviceMakeModelTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeviceTypeAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeviceTypeTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DigitalContentLabelAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DigitalContentLabelTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Dimensions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DoubleVerify + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DoubleVerifyAppStarRating + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DoubleVerifyBrandSafetyCategories + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DoubleVerifyDisplayViewability + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DoubleVerifyFraudInvalidTraffic + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DoubleVerifyVideoViewability + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Empty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EnvironmentAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EnvironmentTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ExchangeAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ExchangeReviewStatus + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ExchangeTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ExitEvent + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FirstAndThirdPartyAudience + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FirstAndThirdPartyAudienceGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FirstAndThirdPartyAudienceTargetingSetting + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FixedBidStrategy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FloodlightGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FrequencyCap + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GenderAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GenderTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GeoRegionAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GeoRegionTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleAudience + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleAudienceGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleAudienceTargetingSetting + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleBytestreamMedia class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class HouseholdIncomeAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class HouseholdIncomeTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class IdFilter class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class InsertionOrder + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InsertionOrderBudget + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InsertionOrderBudgetSegment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntegralAdScience + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntegrationDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InventorySource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InventorySourceAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InventorySourceDisplayCreativeConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class InventorySourceFilter class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class InventorySourceGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InventorySourceGroupAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InventorySourceStatus + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InventorySourceVideoCreativeConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class KeywordAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LanguageAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LanguageTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LineItem + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LineItemBudget + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LineItemFlight + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListAdvertisersResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListCampaignsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListChannelsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListCombinedAudiencesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListCreativesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListCustomListsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListFirstAndThirdPartyAudiencesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListGoogleAudiencesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListInsertionOrdersResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListInventorySourceGroupsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListInventorySourcesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListLineItemAssignedTargetingOptionsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListLineItemsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListLocationListsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListNegativeKeywordListsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListTargetingOptionsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LocationList + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LookbackWindow + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MaximizeSpendBidStrategy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Money + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class NegativeKeywordList + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class NegativeKeywordListAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ObaIcon + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OnScreenPositionAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OnScreenPositionTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OperatingSystemAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OperatingSystemTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Operation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class Pacing + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ParentEntityFilter class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class ParentalStatusAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ParentalStatusTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PartnerCost + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PartnerRevenueModel + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PerformanceGoal + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PerformanceGoalBidStrategy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ProximityLocationListAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PublisherReviewStatus + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RateDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RegionalLocationListAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ReviewStatusInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SdfConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SdfDownloadTask class Representation < Google::Apis::Core::JsonRepresentation; end @@ -70,12 +976,659 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class SensitiveCategoryAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SensitiveCategoryTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Status class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class SubExchangeAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SubExchangeTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TargetingOption + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ThirdPartyOnlyConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ThirdPartyUrl + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ThirdPartyVerifierAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TimeRange + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TimerEvent + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TrackingFloodlightActivityConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Transcode + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UniversalAdId + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UrlAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UserRewardedContentAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UserRewardedContentTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class VideoPlayerSizeAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class VideoPlayerSizeTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ViewabilityAssignedTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ViewabilityTargetingOptionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ActiveViewVideoViewabilityMetricConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + property :minimum_duration, as: 'minimumDuration' + property :minimum_quartile, as: 'minimumQuartile' + property :minimum_viewability, as: 'minimumViewability' + property :minimum_volume, as: 'minimumVolume' + end + end + + class Adloox + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :excluded_adloox_categories, as: 'excludedAdlooxCategories' + end + end + + class Advertiser + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :ad_server_config, as: 'adServerConfig', class: Google::Apis::DisplayvideoV1::AdvertiserAdServerConfig, decorator: Google::Apis::DisplayvideoV1::AdvertiserAdServerConfig::Representation + + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :creative_config, as: 'creativeConfig', class: Google::Apis::DisplayvideoV1::AdvertiserCreativeConfig, decorator: Google::Apis::DisplayvideoV1::AdvertiserCreativeConfig::Representation + + property :data_access_config, as: 'dataAccessConfig', class: Google::Apis::DisplayvideoV1::AdvertiserDataAccessConfig, decorator: Google::Apis::DisplayvideoV1::AdvertiserDataAccessConfig::Representation + + property :display_name, as: 'displayName' + property :entity_status, as: 'entityStatus' + property :general_config, as: 'generalConfig', class: Google::Apis::DisplayvideoV1::AdvertiserGeneralConfig, decorator: Google::Apis::DisplayvideoV1::AdvertiserGeneralConfig::Representation + + property :integration_details, as: 'integrationDetails', class: Google::Apis::DisplayvideoV1::IntegrationDetails, decorator: Google::Apis::DisplayvideoV1::IntegrationDetails::Representation + + property :name, as: 'name' + property :partner_id, :numeric_string => true, as: 'partnerId' + property :update_time, as: 'updateTime' + end + end + + class AdvertiserAdServerConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cm_hybrid_config, as: 'cmHybridConfig', class: Google::Apis::DisplayvideoV1::CmHybridConfig, decorator: Google::Apis::DisplayvideoV1::CmHybridConfig::Representation + + property :third_party_only_config, as: 'thirdPartyOnlyConfig', class: Google::Apis::DisplayvideoV1::ThirdPartyOnlyConfig, decorator: Google::Apis::DisplayvideoV1::ThirdPartyOnlyConfig::Representation + + end + end + + class AdvertiserCreativeConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dynamic_creative_enabled, as: 'dynamicCreativeEnabled' + property :ias_client_id, :numeric_string => true, as: 'iasClientId' + property :oba_compliance_disabled, as: 'obaComplianceDisabled' + property :video_creative_data_sharing_authorized, as: 'videoCreativeDataSharingAuthorized' + end + end + + class AdvertiserDataAccessConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :sdf_config, as: 'sdfConfig', class: Google::Apis::DisplayvideoV1::AdvertiserSdfConfig, decorator: Google::Apis::DisplayvideoV1::AdvertiserSdfConfig::Representation + + end + end + + class AdvertiserGeneralConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :currency_code, as: 'currencyCode' + property :domain_url, as: 'domainUrl' + property :time_zone, as: 'timeZone' + end + end + + class AdvertiserSdfConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :override_partner_sdf_config, as: 'overridePartnerSdfConfig' + property :sdf_config, as: 'sdfConfig', class: Google::Apis::DisplayvideoV1::SdfConfig, decorator: Google::Apis::DisplayvideoV1::SdfConfig::Representation + + end + end + + class AgeRangeAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :age_range, as: 'ageRange' + property :targeting_option_id, as: 'targetingOptionId' + end + end + + class AgeRangeTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :age_range, as: 'ageRange' + end + end + + class AppAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :app_id, as: 'appId' + property :display_name, as: 'displayName' + property :negative, as: 'negative' + end + end + + class AppCategoryAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + property :negative, as: 'negative' + property :targeting_option_id, as: 'targetingOptionId' + end + end + + class AppCategoryTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + end + end + + class Asset + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content, as: 'content' + property :media_id, :numeric_string => true, as: 'mediaId' + end + end + + class AssetAssociation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :asset, as: 'asset', class: Google::Apis::DisplayvideoV1::Asset, decorator: Google::Apis::DisplayvideoV1::Asset::Representation + + property :role, as: 'role' + end + end + + class AssignedTargetingOption + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :age_range_details, as: 'ageRangeDetails', class: Google::Apis::DisplayvideoV1::AgeRangeAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::AgeRangeAssignedTargetingOptionDetails::Representation + + property :app_category_details, as: 'appCategoryDetails', class: Google::Apis::DisplayvideoV1::AppCategoryAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::AppCategoryAssignedTargetingOptionDetails::Representation + + property :app_details, as: 'appDetails', class: Google::Apis::DisplayvideoV1::AppAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::AppAssignedTargetingOptionDetails::Representation + + property :assigned_targeting_option_id, as: 'assignedTargetingOptionId' + property :audience_group_details, as: 'audienceGroupDetails', class: Google::Apis::DisplayvideoV1::AudienceGroupAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::AudienceGroupAssignedTargetingOptionDetails::Representation + + property :authorized_seller_status_details, as: 'authorizedSellerStatusDetails', class: Google::Apis::DisplayvideoV1::AuthorizedSellerStatusAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::AuthorizedSellerStatusAssignedTargetingOptionDetails::Representation + + property :browser_details, as: 'browserDetails', class: Google::Apis::DisplayvideoV1::BrowserAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::BrowserAssignedTargetingOptionDetails::Representation + + property :carrier_and_isp_details, as: 'carrierAndIspDetails', class: Google::Apis::DisplayvideoV1::CarrierAndIspAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::CarrierAndIspAssignedTargetingOptionDetails::Representation + + property :category_details, as: 'categoryDetails', class: Google::Apis::DisplayvideoV1::CategoryAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::CategoryAssignedTargetingOptionDetails::Representation + + property :channel_details, as: 'channelDetails', class: Google::Apis::DisplayvideoV1::ChannelAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::ChannelAssignedTargetingOptionDetails::Representation + + property :content_instream_position_details, as: 'contentInstreamPositionDetails', class: Google::Apis::DisplayvideoV1::ContentInstreamPositionAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::ContentInstreamPositionAssignedTargetingOptionDetails::Representation + + property :content_outstream_position_details, as: 'contentOutstreamPositionDetails', class: Google::Apis::DisplayvideoV1::ContentOutstreamPositionAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::ContentOutstreamPositionAssignedTargetingOptionDetails::Representation + + property :day_and_time_details, as: 'dayAndTimeDetails', class: Google::Apis::DisplayvideoV1::DayAndTimeAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::DayAndTimeAssignedTargetingOptionDetails::Representation + + property :device_make_model_details, as: 'deviceMakeModelDetails', class: Google::Apis::DisplayvideoV1::DeviceMakeModelAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::DeviceMakeModelAssignedTargetingOptionDetails::Representation + + property :device_type_details, as: 'deviceTypeDetails', class: Google::Apis::DisplayvideoV1::DeviceTypeAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::DeviceTypeAssignedTargetingOptionDetails::Representation + + property :digital_content_label_exclusion_details, as: 'digitalContentLabelExclusionDetails', class: Google::Apis::DisplayvideoV1::DigitalContentLabelAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::DigitalContentLabelAssignedTargetingOptionDetails::Representation + + property :environment_details, as: 'environmentDetails', class: Google::Apis::DisplayvideoV1::EnvironmentAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::EnvironmentAssignedTargetingOptionDetails::Representation + + property :exchange_details, as: 'exchangeDetails', class: Google::Apis::DisplayvideoV1::ExchangeAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::ExchangeAssignedTargetingOptionDetails::Representation + + property :gender_details, as: 'genderDetails', class: Google::Apis::DisplayvideoV1::GenderAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::GenderAssignedTargetingOptionDetails::Representation + + property :geo_region_details, as: 'geoRegionDetails', class: Google::Apis::DisplayvideoV1::GeoRegionAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::GeoRegionAssignedTargetingOptionDetails::Representation + + property :household_income_details, as: 'householdIncomeDetails', class: Google::Apis::DisplayvideoV1::HouseholdIncomeAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::HouseholdIncomeAssignedTargetingOptionDetails::Representation + + property :inheritance, as: 'inheritance' + property :inventory_source_details, as: 'inventorySourceDetails', class: Google::Apis::DisplayvideoV1::InventorySourceAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::InventorySourceAssignedTargetingOptionDetails::Representation + + property :inventory_source_group_details, as: 'inventorySourceGroupDetails', class: Google::Apis::DisplayvideoV1::InventorySourceGroupAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::InventorySourceGroupAssignedTargetingOptionDetails::Representation + + property :keyword_details, as: 'keywordDetails', class: Google::Apis::DisplayvideoV1::KeywordAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::KeywordAssignedTargetingOptionDetails::Representation + + property :language_details, as: 'languageDetails', class: Google::Apis::DisplayvideoV1::LanguageAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::LanguageAssignedTargetingOptionDetails::Representation + + property :name, as: 'name' + property :negative_keyword_list_details, as: 'negativeKeywordListDetails', class: Google::Apis::DisplayvideoV1::NegativeKeywordListAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::NegativeKeywordListAssignedTargetingOptionDetails::Representation + + property :on_screen_position_details, as: 'onScreenPositionDetails', class: Google::Apis::DisplayvideoV1::OnScreenPositionAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::OnScreenPositionAssignedTargetingOptionDetails::Representation + + property :operating_system_details, as: 'operatingSystemDetails', class: Google::Apis::DisplayvideoV1::OperatingSystemAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::OperatingSystemAssignedTargetingOptionDetails::Representation + + property :parental_status_details, as: 'parentalStatusDetails', class: Google::Apis::DisplayvideoV1::ParentalStatusAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::ParentalStatusAssignedTargetingOptionDetails::Representation + + property :proximity_location_list_details, as: 'proximityLocationListDetails', class: Google::Apis::DisplayvideoV1::ProximityLocationListAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::ProximityLocationListAssignedTargetingOptionDetails::Representation + + property :regional_location_list_details, as: 'regionalLocationListDetails', class: Google::Apis::DisplayvideoV1::RegionalLocationListAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::RegionalLocationListAssignedTargetingOptionDetails::Representation + + property :sensitive_category_exclusion_details, as: 'sensitiveCategoryExclusionDetails', class: Google::Apis::DisplayvideoV1::SensitiveCategoryAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::SensitiveCategoryAssignedTargetingOptionDetails::Representation + + property :sub_exchange_details, as: 'subExchangeDetails', class: Google::Apis::DisplayvideoV1::SubExchangeAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::SubExchangeAssignedTargetingOptionDetails::Representation + + property :targeting_type, as: 'targetingType' + property :third_party_verifier_details, as: 'thirdPartyVerifierDetails', class: Google::Apis::DisplayvideoV1::ThirdPartyVerifierAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::ThirdPartyVerifierAssignedTargetingOptionDetails::Representation + + property :url_details, as: 'urlDetails', class: Google::Apis::DisplayvideoV1::UrlAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::UrlAssignedTargetingOptionDetails::Representation + + property :user_rewarded_content_details, as: 'userRewardedContentDetails', class: Google::Apis::DisplayvideoV1::UserRewardedContentAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::UserRewardedContentAssignedTargetingOptionDetails::Representation + + property :video_player_size_details, as: 'videoPlayerSizeDetails', class: Google::Apis::DisplayvideoV1::VideoPlayerSizeAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::VideoPlayerSizeAssignedTargetingOptionDetails::Representation + + property :viewability_details, as: 'viewabilityDetails', class: Google::Apis::DisplayvideoV1::ViewabilityAssignedTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::ViewabilityAssignedTargetingOptionDetails::Representation + + end + end + + class AudienceGroupAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :excluded_first_and_third_party_audience_group, as: 'excludedFirstAndThirdPartyAudienceGroup', class: Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudienceGroup, decorator: Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudienceGroup::Representation + + property :excluded_google_audience_group, as: 'excludedGoogleAudienceGroup', class: Google::Apis::DisplayvideoV1::GoogleAudienceGroup, decorator: Google::Apis::DisplayvideoV1::GoogleAudienceGroup::Representation + + property :included_combined_audience_group, as: 'includedCombinedAudienceGroup', class: Google::Apis::DisplayvideoV1::CombinedAudienceGroup, decorator: Google::Apis::DisplayvideoV1::CombinedAudienceGroup::Representation + + property :included_custom_list_group, as: 'includedCustomListGroup', class: Google::Apis::DisplayvideoV1::CustomListGroup, decorator: Google::Apis::DisplayvideoV1::CustomListGroup::Representation + + collection :included_first_and_third_party_audience_groups, as: 'includedFirstAndThirdPartyAudienceGroups', class: Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudienceGroup, decorator: Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudienceGroup::Representation + + property :included_google_audience_group, as: 'includedGoogleAudienceGroup', class: Google::Apis::DisplayvideoV1::GoogleAudienceGroup, decorator: Google::Apis::DisplayvideoV1::GoogleAudienceGroup::Representation + + end + end + + class AudioVideoOffset + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :percentage, :numeric_string => true, as: 'percentage' + property :seconds, :numeric_string => true, as: 'seconds' + end + end + + class AuthorizedSellerStatusAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :authorized_seller_status, as: 'authorizedSellerStatus' + property :targeting_option_id, as: 'targetingOptionId' + end + end + + class AuthorizedSellerStatusTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :authorized_seller_status, as: 'authorizedSellerStatus' + end + end + + class BiddingStrategy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :fixed_bid, as: 'fixedBid', class: Google::Apis::DisplayvideoV1::FixedBidStrategy, decorator: Google::Apis::DisplayvideoV1::FixedBidStrategy::Representation + + property :maximize_spend_auto_bid, as: 'maximizeSpendAutoBid', class: Google::Apis::DisplayvideoV1::MaximizeSpendBidStrategy, decorator: Google::Apis::DisplayvideoV1::MaximizeSpendBidStrategy::Representation + + property :performance_goal_auto_bid, as: 'performanceGoalAutoBid', class: Google::Apis::DisplayvideoV1::PerformanceGoalBidStrategy, decorator: Google::Apis::DisplayvideoV1::PerformanceGoalBidStrategy::Representation + + end + end + + class BrowserAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + property :negative, as: 'negative' + property :targeting_option_id, as: 'targetingOptionId' + end + end + + class BrowserTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + end + end + + class BulkEditLineItemAssignedTargetingOptionsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :create_requests, as: 'createRequests', class: Google::Apis::DisplayvideoV1::CreateAssignedTargetingOptionsRequest, decorator: Google::Apis::DisplayvideoV1::CreateAssignedTargetingOptionsRequest::Representation + + collection :delete_requests, as: 'deleteRequests', class: Google::Apis::DisplayvideoV1::DeleteAssignedTargetingOptionsRequest, decorator: Google::Apis::DisplayvideoV1::DeleteAssignedTargetingOptionsRequest::Representation + + end + end + + class BulkEditLineItemAssignedTargetingOptionsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :created_assigned_targeting_options, as: 'createdAssignedTargetingOptions', class: Google::Apis::DisplayvideoV1::AssignedTargetingOption, decorator: Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation + + end + end + + class BulkListLineItemAssignedTargetingOptionsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :assigned_targeting_options, as: 'assignedTargetingOptions', class: Google::Apis::DisplayvideoV1::AssignedTargetingOption, decorator: Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class Campaign + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :campaign_flight, as: 'campaignFlight', class: Google::Apis::DisplayvideoV1::CampaignFlight, decorator: Google::Apis::DisplayvideoV1::CampaignFlight::Representation + + property :campaign_goal, as: 'campaignGoal', class: Google::Apis::DisplayvideoV1::CampaignGoal, decorator: Google::Apis::DisplayvideoV1::CampaignGoal::Representation + + property :campaign_id, :numeric_string => true, as: 'campaignId' + property :display_name, as: 'displayName' + property :entity_status, as: 'entityStatus' + property :frequency_cap, as: 'frequencyCap', class: Google::Apis::DisplayvideoV1::FrequencyCap, decorator: Google::Apis::DisplayvideoV1::FrequencyCap::Representation + + property :name, as: 'name' + property :update_time, as: 'updateTime' + end + end + + class CampaignFlight + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :planned_dates, as: 'plannedDates', class: Google::Apis::DisplayvideoV1::DateRange, decorator: Google::Apis::DisplayvideoV1::DateRange::Representation + + property :planned_spend_amount_micros, :numeric_string => true, as: 'plannedSpendAmountMicros' + end + end + + class CampaignGoal + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :campaign_goal_type, as: 'campaignGoalType' + property :performance_goal, as: 'performanceGoal', class: Google::Apis::DisplayvideoV1::PerformanceGoal, decorator: Google::Apis::DisplayvideoV1::PerformanceGoal::Representation + + end + end + + class CarrierAndIspAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + property :negative, as: 'negative' + property :targeting_option_id, as: 'targetingOptionId' + end + end + + class CarrierAndIspTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + property :type, as: 'type' + end + end + + class CategoryAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + property :negative, as: 'negative' + property :targeting_option_id, as: 'targetingOptionId' + end + end + + class CategoryTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + end + end + + class Channel + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :channel_id, :numeric_string => true, as: 'channelId' + property :display_name, as: 'displayName' + property :name, as: 'name' + property :partner_id, :numeric_string => true, as: 'partnerId' + end + end + + class ChannelAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :channel_id, :numeric_string => true, as: 'channelId' + property :negative, as: 'negative' + end + end + + class CmHybridConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cm_account_id, :numeric_string => true, as: 'cmAccountId' + property :cm_floodlight_config_id, :numeric_string => true, as: 'cmFloodlightConfigId' + property :cm_floodlight_linking_authorized, as: 'cmFloodlightLinkingAuthorized' + collection :cm_syncable_site_ids, as: 'cmSyncableSiteIds' + property :dv360_to_cm_cost_reporting_enabled, as: 'dv360ToCmCostReportingEnabled' + property :dv360_to_cm_data_sharing_enabled, as: 'dv360ToCmDataSharingEnabled' + end + end + + class CmTrackingAd + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cm_ad_id, :numeric_string => true, as: 'cmAdId' + property :cm_creative_id, :numeric_string => true, as: 'cmCreativeId' + property :cm_placement_id, :numeric_string => true, as: 'cmPlacementId' + end + end + + class CombinedAudience + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :combined_audience_id, :numeric_string => true, as: 'combinedAudienceId' + property :display_name, as: 'displayName' + property :name, as: 'name' + end + end + + class CombinedAudienceGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :settings, as: 'settings', class: Google::Apis::DisplayvideoV1::CombinedAudienceTargetingSetting, decorator: Google::Apis::DisplayvideoV1::CombinedAudienceTargetingSetting::Representation + + end + end + + class CombinedAudienceTargetingSetting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :combined_audience_id, :numeric_string => true, as: 'combinedAudienceId' + end + end + + class ContentInstreamPositionAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content_instream_position, as: 'contentInstreamPosition' + property :targeting_option_id, as: 'targetingOptionId' + end + end + + class ContentInstreamPositionTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content_instream_position, as: 'contentInstreamPosition' + end + end + + class ContentOutstreamPositionAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content_outstream_position, as: 'contentOutstreamPosition' + property :targeting_option_id, as: 'targetingOptionId' + end + end + + class ContentOutstreamPositionTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content_outstream_position, as: 'contentOutstreamPosition' + end + end + + class ConversionCountingConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :floodlight_activity_configs, as: 'floodlightActivityConfigs', class: Google::Apis::DisplayvideoV1::TrackingFloodlightActivityConfig, decorator: Google::Apis::DisplayvideoV1::TrackingFloodlightActivityConfig::Representation + + property :post_view_count_percentage_millis, :numeric_string => true, as: 'postViewCountPercentageMillis' + end + end + + class CounterEvent + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :reporting_name, as: 'reportingName' + end + end + + class CreateAssetRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :filename, as: 'filename' + end + end + + class CreateAssetResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :asset, as: 'asset', class: Google::Apis::DisplayvideoV1::Asset, decorator: Google::Apis::DisplayvideoV1::Asset::Representation + + end + end + + class CreateAssignedTargetingOptionsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :assigned_targeting_options, as: 'assignedTargetingOptions', class: Google::Apis::DisplayvideoV1::AssignedTargetingOption, decorator: Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation + + property :targeting_type, as: 'targetingType' + end + end + class CreateSdfDownloadTaskRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -91,6 +1644,424 @@ module Google end end + class Creative + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :additional_dimensions, as: 'additionalDimensions', class: Google::Apis::DisplayvideoV1::Dimensions, decorator: Google::Apis::DisplayvideoV1::Dimensions::Representation + + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :appended_tag, as: 'appendedTag' + collection :assets, as: 'assets', class: Google::Apis::DisplayvideoV1::AssetAssociation, decorator: Google::Apis::DisplayvideoV1::AssetAssociation::Representation + + property :cm_placement_id, :numeric_string => true, as: 'cmPlacementId' + property :cm_tracking_ad, as: 'cmTrackingAd', class: Google::Apis::DisplayvideoV1::CmTrackingAd, decorator: Google::Apis::DisplayvideoV1::CmTrackingAd::Representation + + collection :companion_creative_ids, as: 'companionCreativeIds' + collection :counter_events, as: 'counterEvents', class: Google::Apis::DisplayvideoV1::CounterEvent, decorator: Google::Apis::DisplayvideoV1::CounterEvent::Representation + + property :create_time, as: 'createTime' + collection :creative_attributes, as: 'creativeAttributes' + property :creative_id, :numeric_string => true, as: 'creativeId' + property :creative_type, as: 'creativeType' + property :dimensions, as: 'dimensions', class: Google::Apis::DisplayvideoV1::Dimensions, decorator: Google::Apis::DisplayvideoV1::Dimensions::Representation + + property :display_name, as: 'displayName' + property :dynamic, as: 'dynamic' + property :entity_status, as: 'entityStatus' + collection :exit_events, as: 'exitEvents', class: Google::Apis::DisplayvideoV1::ExitEvent, decorator: Google::Apis::DisplayvideoV1::ExitEvent::Representation + + property :expand_on_hover, as: 'expandOnHover' + property :expanding_direction, as: 'expandingDirection' + property :hosting_source, as: 'hostingSource' + property :html5_video, as: 'html5Video' + property :ias_campaign_monitoring, as: 'iasCampaignMonitoring' + property :integration_code, as: 'integrationCode' + property :js_tracker_url, as: 'jsTrackerUrl' + property :media_duration, as: 'mediaDuration' + property :name, as: 'name' + property :notes, as: 'notes' + property :oba_icon, as: 'obaIcon', class: Google::Apis::DisplayvideoV1::ObaIcon, decorator: Google::Apis::DisplayvideoV1::ObaIcon::Representation + + property :progress_offset, as: 'progressOffset', class: Google::Apis::DisplayvideoV1::AudioVideoOffset, decorator: Google::Apis::DisplayvideoV1::AudioVideoOffset::Representation + + property :require_html5, as: 'requireHtml5' + property :require_mraid, as: 'requireMraid' + property :require_ping_for_attribution, as: 'requirePingForAttribution' + property :review_status, as: 'reviewStatus', class: Google::Apis::DisplayvideoV1::ReviewStatusInfo, decorator: Google::Apis::DisplayvideoV1::ReviewStatusInfo::Representation + + property :skip_offset, as: 'skipOffset', class: Google::Apis::DisplayvideoV1::AudioVideoOffset, decorator: Google::Apis::DisplayvideoV1::AudioVideoOffset::Representation + + property :skippable, as: 'skippable' + property :third_party_tag, as: 'thirdPartyTag' + collection :third_party_urls, as: 'thirdPartyUrls', class: Google::Apis::DisplayvideoV1::ThirdPartyUrl, decorator: Google::Apis::DisplayvideoV1::ThirdPartyUrl::Representation + + collection :timer_events, as: 'timerEvents', class: Google::Apis::DisplayvideoV1::TimerEvent, decorator: Google::Apis::DisplayvideoV1::TimerEvent::Representation + + collection :tracker_urls, as: 'trackerUrls' + collection :transcodes, as: 'transcodes', class: Google::Apis::DisplayvideoV1::Transcode, decorator: Google::Apis::DisplayvideoV1::Transcode::Representation + + property :universal_ad_id, as: 'universalAdId', class: Google::Apis::DisplayvideoV1::UniversalAdId, decorator: Google::Apis::DisplayvideoV1::UniversalAdId::Representation + + property :update_time, as: 'updateTime' + property :vast_tag_url, as: 'vastTagUrl' + property :vpaid, as: 'vpaid' + end + end + + class CreativeConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :creative_type, as: 'creativeType' + property :display_creative_config, as: 'displayCreativeConfig', class: Google::Apis::DisplayvideoV1::InventorySourceDisplayCreativeConfig, decorator: Google::Apis::DisplayvideoV1::InventorySourceDisplayCreativeConfig::Representation + + property :video_creative_config, as: 'videoCreativeConfig', class: Google::Apis::DisplayvideoV1::InventorySourceVideoCreativeConfig, decorator: Google::Apis::DisplayvideoV1::InventorySourceVideoCreativeConfig::Representation + + end + end + + class CustomList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :custom_list_id, :numeric_string => true, as: 'customListId' + property :display_name, as: 'displayName' + property :name, as: 'name' + end + end + + class CustomListGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :settings, as: 'settings', class: Google::Apis::DisplayvideoV1::CustomListTargetingSetting, decorator: Google::Apis::DisplayvideoV1::CustomListTargetingSetting::Representation + + end + end + + class CustomListTargetingSetting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :custom_list_id, :numeric_string => true, as: 'customListId' + end + end + + class Date + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :day, as: 'day' + property :month, as: 'month' + property :year, as: 'year' + end + end + + class DateRange + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_date, as: 'endDate', class: Google::Apis::DisplayvideoV1::Date, decorator: Google::Apis::DisplayvideoV1::Date::Representation + + property :start_date, as: 'startDate', class: Google::Apis::DisplayvideoV1::Date, decorator: Google::Apis::DisplayvideoV1::Date::Representation + + end + end + + class DayAndTimeAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :day_of_week, as: 'dayOfWeek' + property :end_hour, as: 'endHour' + property :start_hour, as: 'startHour' + property :time_zone_resolution, as: 'timeZoneResolution' + end + end + + class DeleteAssignedTargetingOptionsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :assigned_targeting_option_ids, as: 'assignedTargetingOptionIds' + property :targeting_type, as: 'targetingType' + end + end + + class DeviceMakeModelAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + property :negative, as: 'negative' + property :targeting_option_id, as: 'targetingOptionId' + end + end + + class DeviceMakeModelTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + end + end + + class DeviceTypeAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :device_type, as: 'deviceType' + property :targeting_option_id, as: 'targetingOptionId' + end + end + + class DeviceTypeTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :device_type, as: 'deviceType' + end + end + + class DigitalContentLabelAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content_rating_tier, as: 'contentRatingTier' + property :excluded_targeting_option_id, as: 'excludedTargetingOptionId' + end + end + + class DigitalContentLabelTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content_rating_tier, as: 'contentRatingTier' + end + end + + class Dimensions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :height_pixels, as: 'heightPixels' + property :width_pixels, as: 'widthPixels' + end + end + + class DoubleVerify + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :app_star_rating, as: 'appStarRating', class: Google::Apis::DisplayvideoV1::DoubleVerifyAppStarRating, decorator: Google::Apis::DisplayvideoV1::DoubleVerifyAppStarRating::Representation + + collection :avoided_age_ratings, as: 'avoidedAgeRatings' + property :brand_safety_categories, as: 'brandSafetyCategories', class: Google::Apis::DisplayvideoV1::DoubleVerifyBrandSafetyCategories, decorator: Google::Apis::DisplayvideoV1::DoubleVerifyBrandSafetyCategories::Representation + + property :display_viewability, as: 'displayViewability', class: Google::Apis::DisplayvideoV1::DoubleVerifyDisplayViewability, decorator: Google::Apis::DisplayvideoV1::DoubleVerifyDisplayViewability::Representation + + property :fraud_invalid_traffic, as: 'fraudInvalidTraffic', class: Google::Apis::DisplayvideoV1::DoubleVerifyFraudInvalidTraffic, decorator: Google::Apis::DisplayvideoV1::DoubleVerifyFraudInvalidTraffic::Representation + + property :video_viewability, as: 'videoViewability', class: Google::Apis::DisplayvideoV1::DoubleVerifyVideoViewability, decorator: Google::Apis::DisplayvideoV1::DoubleVerifyVideoViewability::Representation + + end + end + + class DoubleVerifyAppStarRating + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :avoid_insufficient_star_rating, as: 'avoidInsufficientStarRating' + property :avoided_star_rating, as: 'avoidedStarRating' + end + end + + class DoubleVerifyBrandSafetyCategories + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :avoid_unknown_brand_safety_category, as: 'avoidUnknownBrandSafetyCategory' + collection :avoided_high_severity_categories, as: 'avoidedHighSeverityCategories' + collection :avoided_medium_severity_categories, as: 'avoidedMediumSeverityCategories' + end + end + + class DoubleVerifyDisplayViewability + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :iab, as: 'iab' + property :viewable_during, as: 'viewableDuring' + end + end + + class DoubleVerifyFraudInvalidTraffic + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :avoid_insufficient_option, as: 'avoidInsufficientOption' + property :avoided_fraud_option, as: 'avoidedFraudOption' + end + end + + class DoubleVerifyVideoViewability + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :player_impression_rate, as: 'playerImpressionRate' + property :video_iab, as: 'videoIab' + property :video_viewable_rate, as: 'videoViewableRate' + end + end + + class Empty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class EnvironmentAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :environment, as: 'environment' + property :targeting_option_id, as: 'targetingOptionId' + end + end + + class EnvironmentTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :environment, as: 'environment' + end + end + + class ExchangeAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :targeting_option_id, as: 'targetingOptionId' + end + end + + class ExchangeReviewStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :exchange, as: 'exchange' + property :status, as: 'status' + end + end + + class ExchangeTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :exchange, as: 'exchange' + end + end + + class ExitEvent + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :reporting_name, as: 'reportingName' + property :type, as: 'type' + property :url, as: 'url' + end + end + + class FirstAndThirdPartyAudience + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + property :first_and_third_party_audience_id, :numeric_string => true, as: 'firstAndThirdPartyAudienceId' + property :first_and_third_party_audience_type, as: 'firstAndThirdPartyAudienceType' + property :name, as: 'name' + end + end + + class FirstAndThirdPartyAudienceGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :settings, as: 'settings', class: Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudienceTargetingSetting, decorator: Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudienceTargetingSetting::Representation + + end + end + + class FirstAndThirdPartyAudienceTargetingSetting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :first_and_third_party_audience_id, :numeric_string => true, as: 'firstAndThirdPartyAudienceId' + property :recency, as: 'recency' + end + end + + class FixedBidStrategy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bid_amount_micros, :numeric_string => true, as: 'bidAmountMicros' + end + end + + class FloodlightGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :active_view_config, as: 'activeViewConfig', class: Google::Apis::DisplayvideoV1::ActiveViewVideoViewabilityMetricConfig, decorator: Google::Apis::DisplayvideoV1::ActiveViewVideoViewabilityMetricConfig::Representation + + hash :custom_variables, as: 'customVariables' + property :display_name, as: 'displayName' + property :floodlight_group_id, :numeric_string => true, as: 'floodlightGroupId' + property :lookback_window, as: 'lookbackWindow', class: Google::Apis::DisplayvideoV1::LookbackWindow, decorator: Google::Apis::DisplayvideoV1::LookbackWindow::Representation + + property :name, as: 'name' + property :web_tag_type, as: 'webTagType' + end + end + + class FrequencyCap + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :max_impressions, as: 'maxImpressions' + property :time_unit, as: 'timeUnit' + property :time_unit_count, as: 'timeUnitCount' + property :unlimited, as: 'unlimited' + end + end + + class GenderAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :gender, as: 'gender' + property :targeting_option_id, as: 'targetingOptionId' + end + end + + class GenderTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :gender, as: 'gender' + end + end + + class GeoRegionAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + property :geo_region_type, as: 'geoRegionType' + property :negative, as: 'negative' + property :targeting_option_id, as: 'targetingOptionId' + end + end + + class GeoRegionTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + property :geo_region_type, as: 'geoRegionType' + end + end + + class GoogleAudience + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + property :google_audience_id, :numeric_string => true, as: 'googleAudienceId' + property :google_audience_type, as: 'googleAudienceType' + property :name, as: 'name' + end + end + + class GoogleAudienceGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :settings, as: 'settings', class: Google::Apis::DisplayvideoV1::GoogleAudienceTargetingSetting, decorator: Google::Apis::DisplayvideoV1::GoogleAudienceTargetingSetting::Representation + + end + end + + class GoogleAudienceTargetingSetting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :google_audience_id, :numeric_string => true, as: 'googleAudienceId' + end + end + class GoogleBytestreamMedia # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -98,6 +2069,21 @@ module Google end end + class HouseholdIncomeAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :household_income, as: 'householdIncome' + property :targeting_option_id, as: 'targetingOptionId' + end + end + + class HouseholdIncomeTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :household_income, as: 'householdIncome' + end + end + class IdFilter # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -110,6 +2096,120 @@ module Google end end + class InsertionOrder + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :bid_strategy, as: 'bidStrategy', class: Google::Apis::DisplayvideoV1::BiddingStrategy, decorator: Google::Apis::DisplayvideoV1::BiddingStrategy::Representation + + property :budget, as: 'budget', class: Google::Apis::DisplayvideoV1::InsertionOrderBudget, decorator: Google::Apis::DisplayvideoV1::InsertionOrderBudget::Representation + + property :campaign_id, :numeric_string => true, as: 'campaignId' + property :display_name, as: 'displayName' + property :entity_status, as: 'entityStatus' + property :frequency_cap, as: 'frequencyCap', class: Google::Apis::DisplayvideoV1::FrequencyCap, decorator: Google::Apis::DisplayvideoV1::FrequencyCap::Representation + + property :insertion_order_id, :numeric_string => true, as: 'insertionOrderId' + property :integration_details, as: 'integrationDetails', class: Google::Apis::DisplayvideoV1::IntegrationDetails, decorator: Google::Apis::DisplayvideoV1::IntegrationDetails::Representation + + property :name, as: 'name' + property :pacing, as: 'pacing', class: Google::Apis::DisplayvideoV1::Pacing, decorator: Google::Apis::DisplayvideoV1::Pacing::Representation + + collection :partner_costs, as: 'partnerCosts', class: Google::Apis::DisplayvideoV1::PartnerCost, decorator: Google::Apis::DisplayvideoV1::PartnerCost::Representation + + property :performance_goal, as: 'performanceGoal', class: Google::Apis::DisplayvideoV1::PerformanceGoal, decorator: Google::Apis::DisplayvideoV1::PerformanceGoal::Representation + + property :update_time, as: 'updateTime' + end + end + + class InsertionOrderBudget + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :automation_type, as: 'automationType' + collection :budget_segments, as: 'budgetSegments', class: Google::Apis::DisplayvideoV1::InsertionOrderBudgetSegment, decorator: Google::Apis::DisplayvideoV1::InsertionOrderBudgetSegment::Representation + + property :budget_unit, as: 'budgetUnit' + end + end + + class InsertionOrderBudgetSegment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :budget_amount_micros, :numeric_string => true, as: 'budgetAmountMicros' + property :campaign_budget_id, :numeric_string => true, as: 'campaignBudgetId' + property :date_range, as: 'dateRange', class: Google::Apis::DisplayvideoV1::DateRange, decorator: Google::Apis::DisplayvideoV1::DateRange::Representation + + property :description, as: 'description' + end + end + + class IntegralAdScience + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_viewability, as: 'displayViewability' + property :exclude_unrateable, as: 'excludeUnrateable' + property :excluded_ad_fraud_risk, as: 'excludedAdFraudRisk' + property :excluded_adult_risk, as: 'excludedAdultRisk' + property :excluded_alcohol_risk, as: 'excludedAlcoholRisk' + property :excluded_drugs_risk, as: 'excludedDrugsRisk' + property :excluded_gambling_risk, as: 'excludedGamblingRisk' + property :excluded_hate_speech_risk, as: 'excludedHateSpeechRisk' + property :excluded_illegal_downloads_risk, as: 'excludedIllegalDownloadsRisk' + property :excluded_offensive_language_risk, as: 'excludedOffensiveLanguageRisk' + property :excluded_violence_risk, as: 'excludedViolenceRisk' + property :traq_score_option, as: 'traqScoreOption' + property :video_viewability, as: 'videoViewability' + end + end + + class IntegrationDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :details, as: 'details' + property :integration_code, as: 'integrationCode' + end + end + + class InventorySource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :commitment, as: 'commitment' + collection :creative_configs, as: 'creativeConfigs', class: Google::Apis::DisplayvideoV1::CreativeConfig, decorator: Google::Apis::DisplayvideoV1::CreativeConfig::Representation + + property :deal_id, as: 'dealId' + property :delivery_method, as: 'deliveryMethod' + property :display_name, as: 'displayName' + property :exchange, as: 'exchange' + property :inventory_source_id, :numeric_string => true, as: 'inventorySourceId' + property :inventory_source_type, as: 'inventorySourceType' + property :name, as: 'name' + property :publisher_name, as: 'publisherName' + property :rate_details, as: 'rateDetails', class: Google::Apis::DisplayvideoV1::RateDetails, decorator: Google::Apis::DisplayvideoV1::RateDetails::Representation + + property :status, as: 'status', class: Google::Apis::DisplayvideoV1::InventorySourceStatus, decorator: Google::Apis::DisplayvideoV1::InventorySourceStatus::Representation + + property :time_range, as: 'timeRange', class: Google::Apis::DisplayvideoV1::TimeRange, decorator: Google::Apis::DisplayvideoV1::TimeRange::Representation + + property :update_time, as: 'updateTime' + end + end + + class InventorySourceAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :inventory_source_id, :numeric_string => true, as: 'inventorySourceId' + end + end + + class InventorySourceDisplayCreativeConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :creative_size, as: 'creativeSize', class: Google::Apis::DisplayvideoV1::Dimensions, decorator: Google::Apis::DisplayvideoV1::Dimensions::Representation + + end + end + class InventorySourceFilter # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -117,6 +2217,360 @@ module Google end end + class InventorySourceGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + property :inventory_source_group_id, :numeric_string => true, as: 'inventorySourceGroupId' + property :name, as: 'name' + end + end + + class InventorySourceGroupAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :inventory_source_group_id, :numeric_string => true, as: 'inventorySourceGroupId' + end + end + + class InventorySourceStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :config_status, as: 'configStatus' + property :entity_pause_reason, as: 'entityPauseReason' + property :entity_status, as: 'entityStatus' + property :seller_pause_reason, as: 'sellerPauseReason' + property :seller_status, as: 'sellerStatus' + end + end + + class InventorySourceVideoCreativeConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :duration, as: 'duration' + end + end + + class KeywordAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :keyword, as: 'keyword' + property :negative, as: 'negative' + end + end + + class LanguageAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + property :negative, as: 'negative' + property :targeting_option_id, as: 'targetingOptionId' + end + end + + class LanguageTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + end + end + + class LineItem + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :bid_strategy, as: 'bidStrategy', class: Google::Apis::DisplayvideoV1::BiddingStrategy, decorator: Google::Apis::DisplayvideoV1::BiddingStrategy::Representation + + property :budget, as: 'budget', class: Google::Apis::DisplayvideoV1::LineItemBudget, decorator: Google::Apis::DisplayvideoV1::LineItemBudget::Representation + + property :campaign_id, :numeric_string => true, as: 'campaignId' + property :conversion_counting, as: 'conversionCounting', class: Google::Apis::DisplayvideoV1::ConversionCountingConfig, decorator: Google::Apis::DisplayvideoV1::ConversionCountingConfig::Representation + + collection :creative_ids, as: 'creativeIds' + property :display_name, as: 'displayName' + property :entity_status, as: 'entityStatus' + property :flight, as: 'flight', class: Google::Apis::DisplayvideoV1::LineItemFlight, decorator: Google::Apis::DisplayvideoV1::LineItemFlight::Representation + + property :frequency_cap, as: 'frequencyCap', class: Google::Apis::DisplayvideoV1::FrequencyCap, decorator: Google::Apis::DisplayvideoV1::FrequencyCap::Representation + + property :insertion_order_id, :numeric_string => true, as: 'insertionOrderId' + property :integration_details, as: 'integrationDetails', class: Google::Apis::DisplayvideoV1::IntegrationDetails, decorator: Google::Apis::DisplayvideoV1::IntegrationDetails::Representation + + collection :inventory_source_ids, as: 'inventorySourceIds' + property :line_item_id, :numeric_string => true, as: 'lineItemId' + property :line_item_type, as: 'lineItemType' + property :name, as: 'name' + property :pacing, as: 'pacing', class: Google::Apis::DisplayvideoV1::Pacing, decorator: Google::Apis::DisplayvideoV1::Pacing::Representation + + collection :partner_costs, as: 'partnerCosts', class: Google::Apis::DisplayvideoV1::PartnerCost, decorator: Google::Apis::DisplayvideoV1::PartnerCost::Representation + + property :partner_revenue_model, as: 'partnerRevenueModel', class: Google::Apis::DisplayvideoV1::PartnerRevenueModel, decorator: Google::Apis::DisplayvideoV1::PartnerRevenueModel::Representation + + property :update_time, as: 'updateTime' + end + end + + class LineItemBudget + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :budget_allocation_type, as: 'budgetAllocationType' + property :budget_unit, as: 'budgetUnit' + property :max_amount, :numeric_string => true, as: 'maxAmount' + end + end + + class LineItemFlight + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :date_range, as: 'dateRange', class: Google::Apis::DisplayvideoV1::DateRange, decorator: Google::Apis::DisplayvideoV1::DateRange::Representation + + property :flight_date_type, as: 'flightDateType' + end + end + + class ListAdvertisersResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :advertisers, as: 'advertisers', class: Google::Apis::DisplayvideoV1::Advertiser, decorator: Google::Apis::DisplayvideoV1::Advertiser::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListCampaignsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :campaigns, as: 'campaigns', class: Google::Apis::DisplayvideoV1::Campaign, decorator: Google::Apis::DisplayvideoV1::Campaign::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListChannelsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :channels, as: 'channels', class: Google::Apis::DisplayvideoV1::Channel, decorator: Google::Apis::DisplayvideoV1::Channel::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListCombinedAudiencesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :combined_audiences, as: 'combinedAudiences', class: Google::Apis::DisplayvideoV1::CombinedAudience, decorator: Google::Apis::DisplayvideoV1::CombinedAudience::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListCreativesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :creatives, as: 'creatives', class: Google::Apis::DisplayvideoV1::Creative, decorator: Google::Apis::DisplayvideoV1::Creative::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListCustomListsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :custom_lists, as: 'customLists', class: Google::Apis::DisplayvideoV1::CustomList, decorator: Google::Apis::DisplayvideoV1::CustomList::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListFirstAndThirdPartyAudiencesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :first_and_third_party_audiences, as: 'firstAndThirdPartyAudiences', class: Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudience, decorator: Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudience::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListGoogleAudiencesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :google_audiences, as: 'googleAudiences', class: Google::Apis::DisplayvideoV1::GoogleAudience, decorator: Google::Apis::DisplayvideoV1::GoogleAudience::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListInsertionOrdersResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :insertion_orders, as: 'insertionOrders', class: Google::Apis::DisplayvideoV1::InsertionOrder, decorator: Google::Apis::DisplayvideoV1::InsertionOrder::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListInventorySourceGroupsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :inventory_source_groups, as: 'inventorySourceGroups', class: Google::Apis::DisplayvideoV1::InventorySourceGroup, decorator: Google::Apis::DisplayvideoV1::InventorySourceGroup::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListInventorySourcesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :inventory_sources, as: 'inventorySources', class: Google::Apis::DisplayvideoV1::InventorySource, decorator: Google::Apis::DisplayvideoV1::InventorySource::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListLineItemAssignedTargetingOptionsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :assigned_targeting_options, as: 'assignedTargetingOptions', class: Google::Apis::DisplayvideoV1::AssignedTargetingOption, decorator: Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListLineItemsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :line_items, as: 'lineItems', class: Google::Apis::DisplayvideoV1::LineItem, decorator: Google::Apis::DisplayvideoV1::LineItem::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListLocationListsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :location_lists, as: 'locationLists', class: Google::Apis::DisplayvideoV1::LocationList, decorator: Google::Apis::DisplayvideoV1::LocationList::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListNegativeKeywordListsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :negative_keyword_lists, as: 'negativeKeywordLists', class: Google::Apis::DisplayvideoV1::NegativeKeywordList, decorator: Google::Apis::DisplayvideoV1::NegativeKeywordList::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListTargetingOptionsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :targeting_options, as: 'targetingOptions', class: Google::Apis::DisplayvideoV1::TargetingOption, decorator: Google::Apis::DisplayvideoV1::TargetingOption::Representation + + end + end + + class LocationList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :display_name, as: 'displayName' + property :location_list_id, :numeric_string => true, as: 'locationListId' + property :location_type, as: 'locationType' + property :name, as: 'name' + end + end + + class LookbackWindow + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :click_days, as: 'clickDays' + property :impression_days, as: 'impressionDays' + end + end + + class MaximizeSpendBidStrategy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :max_average_cpm_bid_amount_micros, :numeric_string => true, as: 'maxAverageCpmBidAmountMicros' + property :performance_goal_type, as: 'performanceGoalType' + end + end + + class Money + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :currency_code, as: 'currencyCode' + property :nanos, as: 'nanos' + property :units, :numeric_string => true, as: 'units' + end + end + + class NegativeKeywordList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :display_name, as: 'displayName' + property :name, as: 'name' + property :negative_keyword_list_id, :numeric_string => true, as: 'negativeKeywordListId' + end + end + + class NegativeKeywordListAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :negative_keyword_list_id, :numeric_string => true, as: 'negativeKeywordListId' + end + end + + class ObaIcon + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :click_tracking_url, as: 'clickTrackingUrl' + property :dimensions, as: 'dimensions', class: Google::Apis::DisplayvideoV1::Dimensions, decorator: Google::Apis::DisplayvideoV1::Dimensions::Representation + + property :landing_page_url, as: 'landingPageUrl' + property :position, as: 'position' + property :program, as: 'program' + property :resource_mime_type, as: 'resourceMimeType' + property :resource_url, as: 'resourceUrl' + property :view_tracking_url, as: 'viewTrackingUrl' + end + end + + class OnScreenPositionAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :on_screen_position, as: 'onScreenPosition' + property :targeting_option_id, as: 'targetingOptionId' + end + end + + class OnScreenPositionTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :on_screen_position, as: 'onScreenPosition' + end + end + + class OperatingSystemAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + property :negative, as: 'negative' + property :targeting_option_id, as: 'targetingOptionId' + end + end + + class OperatingSystemTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + end + end + class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -129,6 +2583,16 @@ module Google end end + class Pacing + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :daily_max_impressions, :numeric_string => true, as: 'dailyMaxImpressions' + property :daily_max_micros, :numeric_string => true, as: 'dailyMaxMicros' + property :pacing_period, as: 'pacingPeriod' + property :pacing_type, as: 'pacingType' + end + end + class ParentEntityFilter # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -138,6 +2602,116 @@ module Google end end + class ParentalStatusAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :parental_status, as: 'parentalStatus' + property :targeting_option_id, as: 'targetingOptionId' + end + end + + class ParentalStatusTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :parental_status, as: 'parentalStatus' + end + end + + class PartnerCost + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cost_type, as: 'costType' + property :fee_amount, :numeric_string => true, as: 'feeAmount' + property :fee_percentage_millis, :numeric_string => true, as: 'feePercentageMillis' + property :fee_type, as: 'feeType' + property :invoice_type, as: 'invoiceType' + end + end + + class PartnerRevenueModel + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :markup_amount, :numeric_string => true, as: 'markupAmount' + property :markup_type, as: 'markupType' + end + end + + class PerformanceGoal + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :performance_goal_amount_micros, :numeric_string => true, as: 'performanceGoalAmountMicros' + property :performance_goal_percentage_micros, :numeric_string => true, as: 'performanceGoalPercentageMicros' + property :performance_goal_string, as: 'performanceGoalString' + property :performance_goal_type, as: 'performanceGoalType' + end + end + + class PerformanceGoalBidStrategy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :max_average_cpm_bid_amount_micros, :numeric_string => true, as: 'maxAverageCpmBidAmountMicros' + property :performance_goal_amount_micros, :numeric_string => true, as: 'performanceGoalAmountMicros' + property :performance_goal_type, as: 'performanceGoalType' + end + end + + class ProximityLocationListAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :proximity_location_list_id, :numeric_string => true, as: 'proximityLocationListId' + property :proximity_radius_range, as: 'proximityRadiusRange' + end + end + + class PublisherReviewStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :publisher_name, as: 'publisherName' + property :status, as: 'status' + end + end + + class RateDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :inventory_source_rate_type, as: 'inventorySourceRateType' + property :minimum_spend, as: 'minimumSpend', class: Google::Apis::DisplayvideoV1::Money, decorator: Google::Apis::DisplayvideoV1::Money::Representation + + property :rate, as: 'rate', class: Google::Apis::DisplayvideoV1::Money, decorator: Google::Apis::DisplayvideoV1::Money::Representation + + property :units_purchased, :numeric_string => true, as: 'unitsPurchased' + end + end + + class RegionalLocationListAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :negative, as: 'negative' + property :regional_location_list_id, :numeric_string => true, as: 'regionalLocationListId' + end + end + + class ReviewStatusInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :approval_status, as: 'approvalStatus' + property :content_and_policy_review_status, as: 'contentAndPolicyReviewStatus' + property :creative_and_landing_page_review_status, as: 'creativeAndLandingPageReviewStatus' + collection :exchange_review_statuses, as: 'exchangeReviewStatuses', class: Google::Apis::DisplayvideoV1::ExchangeReviewStatus, decorator: Google::Apis::DisplayvideoV1::ExchangeReviewStatus::Representation + + collection :publisher_review_statuses, as: 'publisherReviewStatuses', class: Google::Apis::DisplayvideoV1::PublisherReviewStatus, decorator: Google::Apis::DisplayvideoV1::PublisherReviewStatus::Representation + + end + end + + class SdfConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :admin_email, as: 'adminEmail' + property :version, as: 'version' + end + end + class SdfDownloadTask # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -154,6 +2728,21 @@ module Google end end + class SensitiveCategoryAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :excluded_targeting_option_id, as: 'excludedTargetingOptionId' + property :sensitive_category, as: 'sensitiveCategory' + end + end + + class SensitiveCategoryTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :sensitive_category, as: 'sensitiveCategory' + end + end + class Status # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -162,6 +2751,208 @@ module Google property :message, as: 'message' end end + + class SubExchangeAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :targeting_option_id, as: 'targetingOptionId' + end + end + + class SubExchangeTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + end + end + + class TargetingOption + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :age_range_details, as: 'ageRangeDetails', class: Google::Apis::DisplayvideoV1::AgeRangeTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::AgeRangeTargetingOptionDetails::Representation + + property :app_category_details, as: 'appCategoryDetails', class: Google::Apis::DisplayvideoV1::AppCategoryTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::AppCategoryTargetingOptionDetails::Representation + + property :authorized_seller_status_details, as: 'authorizedSellerStatusDetails', class: Google::Apis::DisplayvideoV1::AuthorizedSellerStatusTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::AuthorizedSellerStatusTargetingOptionDetails::Representation + + property :browser_details, as: 'browserDetails', class: Google::Apis::DisplayvideoV1::BrowserTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::BrowserTargetingOptionDetails::Representation + + property :carrier_and_isp_details, as: 'carrierAndIspDetails', class: Google::Apis::DisplayvideoV1::CarrierAndIspTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::CarrierAndIspTargetingOptionDetails::Representation + + property :category_details, as: 'categoryDetails', class: Google::Apis::DisplayvideoV1::CategoryTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::CategoryTargetingOptionDetails::Representation + + property :content_instream_position_details, as: 'contentInstreamPositionDetails', class: Google::Apis::DisplayvideoV1::ContentInstreamPositionTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::ContentInstreamPositionTargetingOptionDetails::Representation + + property :content_outstream_position_details, as: 'contentOutstreamPositionDetails', class: Google::Apis::DisplayvideoV1::ContentOutstreamPositionTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::ContentOutstreamPositionTargetingOptionDetails::Representation + + property :device_make_model_details, as: 'deviceMakeModelDetails', class: Google::Apis::DisplayvideoV1::DeviceMakeModelTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::DeviceMakeModelTargetingOptionDetails::Representation + + property :device_type_details, as: 'deviceTypeDetails', class: Google::Apis::DisplayvideoV1::DeviceTypeTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::DeviceTypeTargetingOptionDetails::Representation + + property :digital_content_label_details, as: 'digitalContentLabelDetails', class: Google::Apis::DisplayvideoV1::DigitalContentLabelTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::DigitalContentLabelTargetingOptionDetails::Representation + + property :environment_details, as: 'environmentDetails', class: Google::Apis::DisplayvideoV1::EnvironmentTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::EnvironmentTargetingOptionDetails::Representation + + property :exchange_details, as: 'exchangeDetails', class: Google::Apis::DisplayvideoV1::ExchangeTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::ExchangeTargetingOptionDetails::Representation + + property :gender_details, as: 'genderDetails', class: Google::Apis::DisplayvideoV1::GenderTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::GenderTargetingOptionDetails::Representation + + property :geo_region_details, as: 'geoRegionDetails', class: Google::Apis::DisplayvideoV1::GeoRegionTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::GeoRegionTargetingOptionDetails::Representation + + property :household_income_details, as: 'householdIncomeDetails', class: Google::Apis::DisplayvideoV1::HouseholdIncomeTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::HouseholdIncomeTargetingOptionDetails::Representation + + property :language_details, as: 'languageDetails', class: Google::Apis::DisplayvideoV1::LanguageTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::LanguageTargetingOptionDetails::Representation + + property :name, as: 'name' + property :on_screen_position_details, as: 'onScreenPositionDetails', class: Google::Apis::DisplayvideoV1::OnScreenPositionTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::OnScreenPositionTargetingOptionDetails::Representation + + property :operating_system_details, as: 'operatingSystemDetails', class: Google::Apis::DisplayvideoV1::OperatingSystemTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::OperatingSystemTargetingOptionDetails::Representation + + property :parental_status_details, as: 'parentalStatusDetails', class: Google::Apis::DisplayvideoV1::ParentalStatusTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::ParentalStatusTargetingOptionDetails::Representation + + property :sensitive_category_details, as: 'sensitiveCategoryDetails', class: Google::Apis::DisplayvideoV1::SensitiveCategoryTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::SensitiveCategoryTargetingOptionDetails::Representation + + property :sub_exchange_details, as: 'subExchangeDetails', class: Google::Apis::DisplayvideoV1::SubExchangeTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::SubExchangeTargetingOptionDetails::Representation + + property :targeting_option_id, as: 'targetingOptionId' + property :targeting_type, as: 'targetingType' + property :user_rewarded_content_details, as: 'userRewardedContentDetails', class: Google::Apis::DisplayvideoV1::UserRewardedContentTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::UserRewardedContentTargetingOptionDetails::Representation + + property :video_player_size_details, as: 'videoPlayerSizeDetails', class: Google::Apis::DisplayvideoV1::VideoPlayerSizeTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::VideoPlayerSizeTargetingOptionDetails::Representation + + property :viewability_details, as: 'viewabilityDetails', class: Google::Apis::DisplayvideoV1::ViewabilityTargetingOptionDetails, decorator: Google::Apis::DisplayvideoV1::ViewabilityTargetingOptionDetails::Representation + + end + end + + class ThirdPartyOnlyConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :pixel_order_id_reporting_enabled, as: 'pixelOrderIdReportingEnabled' + end + end + + class ThirdPartyUrl + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :type, as: 'type' + property :url, as: 'url' + end + end + + class ThirdPartyVerifierAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :adloox, as: 'adloox', class: Google::Apis::DisplayvideoV1::Adloox, decorator: Google::Apis::DisplayvideoV1::Adloox::Representation + + property :double_verify, as: 'doubleVerify', class: Google::Apis::DisplayvideoV1::DoubleVerify, decorator: Google::Apis::DisplayvideoV1::DoubleVerify::Representation + + property :integral_ad_science, as: 'integralAdScience', class: Google::Apis::DisplayvideoV1::IntegralAdScience, decorator: Google::Apis::DisplayvideoV1::IntegralAdScience::Representation + + end + end + + class TimeRange + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_time, as: 'endTime' + property :start_time, as: 'startTime' + end + end + + class TimerEvent + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :reporting_name, as: 'reportingName' + end + end + + class TrackingFloodlightActivityConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :floodlight_activity_id, :numeric_string => true, as: 'floodlightActivityId' + property :post_click_lookback_window_days, as: 'postClickLookbackWindowDays' + property :post_view_lookback_window_days, as: 'postViewLookbackWindowDays' + end + end + + class Transcode + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :audio_bit_rate_kbps, :numeric_string => true, as: 'audioBitRateKbps' + property :audio_sample_rate_hz, :numeric_string => true, as: 'audioSampleRateHz' + property :bit_rate_kbps, :numeric_string => true, as: 'bitRateKbps' + property :dimensions, as: 'dimensions', class: Google::Apis::DisplayvideoV1::Dimensions, decorator: Google::Apis::DisplayvideoV1::Dimensions::Representation + + property :file_size_bytes, :numeric_string => true, as: 'fileSizeBytes' + property :frame_rate, as: 'frameRate' + property :mime_type, as: 'mimeType' + property :name, as: 'name' + property :transcoded, as: 'transcoded' + end + end + + class UniversalAdId + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + property :registry, as: 'registry' + end + end + + class UrlAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :negative, as: 'negative' + property :url, as: 'url' + end + end + + class UserRewardedContentAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :targeting_option_id, as: 'targetingOptionId' + property :user_rewarded_content, as: 'userRewardedContent' + end + end + + class UserRewardedContentTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :user_rewarded_content, as: 'userRewardedContent' + end + end + + class VideoPlayerSizeAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :targeting_option_id, as: 'targetingOptionId' + property :video_player_size, as: 'videoPlayerSize' + end + end + + class VideoPlayerSizeTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :video_player_size, as: 'videoPlayerSize' + end + end + + class ViewabilityAssignedTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :targeting_option_id, as: 'targetingOptionId' + property :viewability, as: 'viewability' + end + end + + class ViewabilityTargetingOptionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :viewability, as: 'viewability' + end + end end end end diff --git a/generated/google/apis/displayvideo_v1/service.rb b/generated/google/apis/displayvideo_v1/service.rb index 573013c21..91d7361f8 100644 --- a/generated/google/apis/displayvideo_v1/service.rb +++ b/generated/google/apis/displayvideo_v1/service.rb @@ -48,6 +48,2467 @@ module Google @batch_path = 'batch' end + # Creates a new advertiser. + # Returns the newly created advertiser if successful. + # This method can take up to 180 seconds to complete. + # @param [Google::Apis::DisplayvideoV1::Advertiser] advertiser_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::Advertiser] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Advertiser] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_advertiser(advertiser_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/advertisers', options) + command.request_representation = Google::Apis::DisplayvideoV1::Advertiser::Representation + command.request_object = advertiser_object + command.response_representation = Google::Apis::DisplayvideoV1::Advertiser::Representation + command.response_class = Google::Apis::DisplayvideoV1::Advertiser + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an advertiser. + # Deleting an advertiser will delete all of its child resources, for example, + # campaigns, insertion orders and line items. + # A deleted advertiser cannot be recovered. + # @param [Fixnum] advertiser_id + # The ID of the advertiser we need to delete. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_advertiser(advertiser_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation + command.response_class = Google::Apis::DisplayvideoV1::Empty + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets an advertiser. + # @param [Fixnum] advertiser_id + # Required. The ID of the advertiser to fetch. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::Advertiser] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Advertiser] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_advertiser(advertiser_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::Advertiser::Representation + command.response_class = Google::Apis::DisplayvideoV1::Advertiser + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists advertisers that are accessible to the current user. + # The order is defined by the order_by + # parameter. + # A single partner_id is required. + # Cross-partner listing is not supported. + # @param [String] filter + # Allows filtering by advertiser properties. + # Supported syntax: + # * Filter expressions are made up of one or more restrictions. + # * Restrictions can be combined by `AND` or `OR` logical operators. A + # sequence of restrictions implicitly uses `AND`. + # * A restriction has the form of ``field` `operator` `value``. + # * The operator must be `EQUALS (=)`. + # * Supported fields: + # - `entityStatus` + # Examples: + # * All active advertisers under a partner: + # `entityStatus="ENTITY_STATUS_ACTIVE"` + # The length of this field should be no more than 500 characters. + # @param [String] order_by + # Field by which to sort the list. + # Acceptable values are: + # * `displayName` (default) + # * `entityStatus` + # The default sorting order is ascending. To specify descending order for + # a field, a suffix "desc" should be added to the field name. For example, + # `displayName desc`. + # @param [Fixnum] page_size + # Requested page size. Must be between `1` and `100`. If unspecified will + # default to `100`. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # next_page_token + # returned from the previous call to `ListAdvertisers` method. + # If not specified, the first page of results will be returned. + # @param [Fixnum] partner_id + # Required. The ID of the partner that the fetched advertisers should all belong + # to. + # The system only supports listing advertisers for one partner at a time. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::ListAdvertisersResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ListAdvertisersResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_advertisers(filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/advertisers', options) + command.response_representation = Google::Apis::DisplayvideoV1::ListAdvertisersResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::ListAdvertisersResponse + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['partnerId'] = partner_id unless partner_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing advertiser. + # Returns the updated advertiser if successful. + # @param [Fixnum] advertiser_id + # Output only. The unique ID of the advertiser. Assigned by the system. + # @param [Google::Apis::DisplayvideoV1::Advertiser] advertiser_object + # @param [String] update_mask + # Required. The mask to control which fields to update. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::Advertiser] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Advertiser] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_advertiser(advertiser_id, advertiser_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/advertisers/{+advertiserId}', options) + command.request_representation = Google::Apis::DisplayvideoV1::Advertiser::Representation + command.request_object = advertiser_object + command.response_representation = Google::Apis::DisplayvideoV1::Advertiser::Representation + command.response_class = Google::Apis::DisplayvideoV1::Advertiser + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Uploads an asset. + # Returns the ID of the newly uploaded asset if successful. + # The asset file size should be no more than 10 MB for images, 200 MB for + # ZIP files, and 1 GB for videos. + # @param [Fixnum] advertiser_id + # Required. The ID of the advertiser this asset belongs to. + # @param [Google::Apis::DisplayvideoV1::CreateAssetRequest] create_asset_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [IO, String] upload_source + # IO stream or filename containing content to upload + # @param [String] content_type + # Content type of the uploaded content. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::CreateAssetResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::CreateAssetResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def upload_advertiser_asset(advertiser_id, create_asset_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block) + if upload_source.nil? + command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/assets', options) + else + command = make_upload_command(:post, 'v1/advertisers/{+advertiserId}/assets', options) + command.upload_source = upload_source + command.upload_content_type = content_type + end + command.request_representation = Google::Apis::DisplayvideoV1::CreateAssetRequest::Representation + command.request_object = create_asset_request_object + command.response_representation = Google::Apis::DisplayvideoV1::CreateAssetResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::CreateAssetResponse + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new campaign. + # Returns the newly created campaign if successful. + # @param [Fixnum] advertiser_id + # Output only. The unique ID of the advertiser the campaign belongs to. + # @param [Google::Apis::DisplayvideoV1::Campaign] campaign_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::Campaign] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Campaign] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_advertiser_campaign(advertiser_id, campaign_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/campaigns', options) + command.request_representation = Google::Apis::DisplayvideoV1::Campaign::Representation + command.request_object = campaign_object + command.response_representation = Google::Apis::DisplayvideoV1::Campaign::Representation + command.response_class = Google::Apis::DisplayvideoV1::Campaign + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Permanently deletes a campaign. A deleted campaign cannot be recovered. + # The campaign should be archived first, i.e. set + # entity_status to `ENTITY_STATUS_ARCHIVED`, to be + # able to delete it. + # @param [Fixnum] advertiser_id + # The ID of the advertiser this campaign belongs to. + # @param [Fixnum] campaign_id + # The ID of the campaign we need to delete. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_advertiser_campaign(advertiser_id, campaign_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}/campaigns/{+campaignId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation + command.response_class = Google::Apis::DisplayvideoV1::Empty + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['campaignId'] = campaign_id unless campaign_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a campaign. + # @param [Fixnum] advertiser_id + # Required. The ID of the advertiser this campaign belongs to. + # @param [Fixnum] campaign_id + # Required. The ID of the campaign to fetch. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::Campaign] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Campaign] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_advertiser_campaign(advertiser_id, campaign_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/campaigns/{+campaignId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::Campaign::Representation + command.response_class = Google::Apis::DisplayvideoV1::Campaign + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['campaignId'] = campaign_id unless campaign_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists campaigns in an advertiser. + # The order is defined by the order_by + # parameter. + # If a filter by + # entity_status is not specified, campaigns with + # `ENTITY_STATUS_ARCHIVED` will not be included in the results. + # @param [Fixnum] advertiser_id + # The ID of the advertiser to list campaigns for. + # @param [String] filter + # Allows filtering by campaign properties. + # Supported syntax: + # * Filter expressions are made up of one or more restrictions. + # * Restrictions can be combined by `AND` or `OR` logical operators. A + # sequence of restrictions implicitly uses `AND`. + # * A restriction has the form of ``field` `operator` `value``. + # * The operator must be `EQUALS (=)`. + # * Supported fields: + # - `entityStatus` + # Examples: + # * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an + # advertiser: + # `(entityStatus="ENTITY_STATUS_ACTIVE" OR + # entityStatus="ENTITY_STATUS_PAUSED")` + # The length of this field should be no more than 500 characters. + # @param [String] order_by + # Field by which to sort the list. + # Acceptable values are: + # * `displayName` (default) + # * `entityStatus` + # The default sorting order is ascending. To specify descending order for + # a field, a suffix "desc" should be added to the field name. Example: + # `displayName desc`. + # @param [Fixnum] page_size + # Requested page size. Must be between `1` and `100`. If unspecified will + # default to `100`. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # next_page_token returned from the + # previous call to `ListCampaigns` method. If not specified, the first page + # of results will be returned. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::ListCampaignsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ListCampaignsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_advertiser_campaigns(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/campaigns', options) + command.response_representation = Google::Apis::DisplayvideoV1::ListCampaignsResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::ListCampaignsResponse + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing campaign. + # Returns the updated campaign if successful. + # @param [Fixnum] advertiser_id + # Output only. The unique ID of the advertiser the campaign belongs to. + # @param [Fixnum] campaign_id + # Output only. The unique ID of the campaign. Assigned by the system. + # @param [Google::Apis::DisplayvideoV1::Campaign] campaign_object + # @param [String] update_mask + # Required. The mask to control which fields to update. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::Campaign] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Campaign] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_advertiser_campaign(advertiser_id, campaign_id, campaign_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/advertisers/{+advertiserId}/campaigns/{+campaignId}', options) + command.request_representation = Google::Apis::DisplayvideoV1::Campaign::Representation + command.request_object = campaign_object + command.response_representation = Google::Apis::DisplayvideoV1::Campaign::Representation + command.response_class = Google::Apis::DisplayvideoV1::Campaign + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['campaignId'] = campaign_id unless campaign_id.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a channel for a partner or advertiser. + # @param [Fixnum] advertiser_id + # The ID of the advertiser that owns the fetched channel. + # @param [Fixnum] channel_id + # Required. The ID of the channel to fetch. + # @param [Fixnum] partner_id + # The ID of the partner that owns the fetched channel. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::Channel] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Channel] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_advertiser_channel(advertiser_id, channel_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/channels/{+channelId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::Channel::Representation + command.response_class = Google::Apis::DisplayvideoV1::Channel + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['channelId'] = channel_id unless channel_id.nil? + command.query['partnerId'] = partner_id unless partner_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists channels for a partner or advertiser. + # @param [Fixnum] advertiser_id + # The ID of the advertiser that owns the channels. + # @param [String] filter + # Allows filtering by channel fields. + # Supported syntax: + # * Filter expressions for channel currently can only contain at most one + # * restriction. + # * A restriction has the form of ``field` `operator` `value``. + # * The operator must be `CONTAINS (:)`. + # * Supported fields: + # - `displayName` + # Examples: + # * All channels for which the display name contains "google": + # `displayName : "google"`. + # The length of this field should be no more than 500 characters. + # @param [String] order_by + # Field by which to sort the list. + # Acceptable values are: + # * `displayName` (default) + # * `channelId` + # The default sorting order is ascending. To specify descending order for a + # field, a suffix " desc" should be added to the field name. Example: + # `displayName desc`. + # @param [Fixnum] page_size + # Requested page size. Must be between `1` and `100`. If unspecified will + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + # is specified. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # next_page_token returned from the + # previous call to `ListChannels` method. If not specified, the first page + # of results will be returned. + # @param [Fixnum] partner_id + # The ID of the partner that owns the channels. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::ListChannelsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ListChannelsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_advertiser_channels(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/channels', options) + command.response_representation = Google::Apis::DisplayvideoV1::ListChannelsResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::ListChannelsResponse + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['partnerId'] = partner_id unless partner_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new creative. + # Returns the newly created creative if successful. + # @param [Fixnum] advertiser_id + # Output only. The unique ID of the advertiser the creative belongs to. + # @param [Google::Apis::DisplayvideoV1::Creative] creative_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::Creative] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Creative] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_advertiser_creative(advertiser_id, creative_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/creatives', options) + command.request_representation = Google::Apis::DisplayvideoV1::Creative::Representation + command.request_object = creative_object + command.response_representation = Google::Apis::DisplayvideoV1::Creative::Representation + command.response_class = Google::Apis::DisplayvideoV1::Creative + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a creative. + # Returns error code `NOT_FOUND` if the creative does not exist. + # The creative should be archived first, i.e. set + # entity_status to `ENTITY_STATUS_ARCHIVED`, before + # it can be deleted. + # @param [Fixnum] advertiser_id + # The ID of the advertiser this creative belongs to. + # @param [Fixnum] creative_id + # The ID of the creative to be deleted. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_advertiser_creative(advertiser_id, creative_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}/creatives/{+creativeId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation + command.response_class = Google::Apis::DisplayvideoV1::Empty + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['creativeId'] = creative_id unless creative_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a creative. + # @param [Fixnum] advertiser_id + # Required. The ID of the advertiser this creative belongs to. + # @param [Fixnum] creative_id + # Required. The ID of the creative to fetch. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::Creative] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Creative] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_advertiser_creative(advertiser_id, creative_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/creatives/{+creativeId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::Creative::Representation + command.response_class = Google::Apis::DisplayvideoV1::Creative + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['creativeId'] = creative_id unless creative_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists creatives in an advertiser. + # The order is defined by the order_by + # parameter. + # If a filter by + # entity_status is not specified, creatives with + # `ENTITY_STATUS_ARCHIVED` will not be included in the results. + # @param [Fixnum] advertiser_id + # Required. The ID of the advertiser to list creatives for. + # @param [String] filter + # Allows filtering by creative properties. + # Supported syntax: + # * Filter expressions are made up of one or more restrictions. + # * Restriction for the same field must be combined by `OR`. + # * Restriction for different fields must be combined by `AND`. + # * Between `(` and `)` there can only be restrictions combined by `OR` + # for the same field. + # * A restriction has the form of ``field` `operator` `value``. + # * The operator must be `EQUALS (=)`. + # * Supported fields: + # - `entityStatus` + # - `creativeType`. + # - `dimensions` + # - `minDuration` + # - `maxDuration` + # - `approvalStatus` + # - `exchangeReviewStatus` + # - `dynamic` + # * For `entityStatus`, `minDuration`, `maxDuration`, and `dynamic` there may + # be at most one restriction. + # * For `dimensions`, the value is in the form of `"`width`x`height`"`. + # * For `exchangeReviewStatus`, the value is in the form of + # ``exchange`-`reviewStatus``. + # * For `minDuration` and `maxDuration`, the value is in the form of + # `"`duration`s"`. Only seconds are supported with millisecond granularity. + # Examples: + # * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` + # * All active creatives with 300x400 or 50x100 dimensions: + # `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" + # OR dimensions="50x100")` + # * All dynamic creatives that are approved by AdX or + # AppNexus, with a minimum duration of 5 seconds and 200ms. + # `dynamic="true" AND minDuration="5.2s" AND + # (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" + # OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` + # The length of this field should be no more than 500 characters. + # @param [String] order_by + # Field by which to sort the list. + # Acceptable values are: + # * `creativeId` (default) + # * `createTime` + # * `mediaDuration` + # * `dimensions` (sorts by width first, then by height) + # The default sorting order is ascending. To specify descending order for + # a field, a suffix "desc" should be added to the field name. + # Example: `createTime desc`. + # @param [Fixnum] page_size + # Requested page size. Must be between `1` and `100`. If unspecified will + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + # is specified. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # next_page_token + # returned from the previous call to `ListCreatives` method. + # If not specified, the first page of results will be returned. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::ListCreativesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ListCreativesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_advertiser_creatives(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/creatives', options) + command.response_representation = Google::Apis::DisplayvideoV1::ListCreativesResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::ListCreativesResponse + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing creative. + # Returns the updated creative if successful. + # @param [Fixnum] advertiser_id + # Output only. The unique ID of the advertiser the creative belongs to. + # @param [Fixnum] creative_id + # Output only. The unique ID of the creative. Assigned by the system. + # @param [Google::Apis::DisplayvideoV1::Creative] creative_object + # @param [String] update_mask + # Required. The mask to control which fields to update. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::Creative] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Creative] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_advertiser_creative(advertiser_id, creative_id, creative_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/advertisers/{+advertiserId}/creatives/{+creativeId}', options) + command.request_representation = Google::Apis::DisplayvideoV1::Creative::Representation + command.request_object = creative_object + command.response_representation = Google::Apis::DisplayvideoV1::Creative::Representation + command.response_class = Google::Apis::DisplayvideoV1::Creative + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['creativeId'] = creative_id unless creative_id.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new insertion order. + # Returns the newly created insertion order if successful. + # @param [Fixnum] advertiser_id + # Output only. The unique ID of the advertiser the insertion order belongs to. + # @param [Google::Apis::DisplayvideoV1::InsertionOrder] insertion_order_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::InsertionOrder] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::InsertionOrder] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_advertiser_insertion_order(advertiser_id, insertion_order_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/insertionOrders', options) + command.request_representation = Google::Apis::DisplayvideoV1::InsertionOrder::Representation + command.request_object = insertion_order_object + command.response_representation = Google::Apis::DisplayvideoV1::InsertionOrder::Representation + command.response_class = Google::Apis::DisplayvideoV1::InsertionOrder + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an insertion order. + # Returns error code `NOT_FOUND` if the insertion order does not exist. + # The insertion order should be archived first, i.e. set + # entity_status to `ENTITY_STATUS_ARCHIVED`, + # to be able to delete it. + # @param [Fixnum] advertiser_id + # The ID of the advertiser this insertion order belongs to. + # @param [Fixnum] insertion_order_id + # The ID of the insertion order we need to delete. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_advertiser_insertion_order(advertiser_id, insertion_order_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation + command.response_class = Google::Apis::DisplayvideoV1::Empty + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets an insertion order. + # Returns error code `NOT_FOUND` if the insertion order does not exist. + # @param [Fixnum] advertiser_id + # Required. The ID of the advertiser this insertion order belongs to. + # @param [Fixnum] insertion_order_id + # Required. The ID of the insertion order to fetch. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::InsertionOrder] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::InsertionOrder] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_advertiser_insertion_order(advertiser_id, insertion_order_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::InsertionOrder::Representation + command.response_class = Google::Apis::DisplayvideoV1::InsertionOrder + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists insertion orders in an advertiser. + # The order is defined by the order_by + # parameter. + # If a filter by + # entity_status is not specified, insertion + # orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results. + # @param [Fixnum] advertiser_id + # Required. The ID of the advertiser to list insertion orders for. + # @param [String] filter + # Allows filtering by insertion order properties. + # Supported syntax: + # * Filter expressions are made up of one or more restrictions. + # * Restrictions can be combined by `AND` or `OR` logical operators. A + # sequence of restrictions implicitly uses `AND`. + # * A restriction has the form of ``field` `operator` `value``. + # * The operator must be `EQUALS (=)`. + # * Supported fields: + # - `campaignId` + # - `entityStatus` + # Examples: + # * All insertion orders under a campaign: `campaignId="1234"` + # * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders + # under an advertiser: + # `(entityStatus="ENTITY_STATUS_ACTIVE" OR + # entityStatus="ENTITY_STATUS_PAUSED")` + # The length of this field should be no more than 500 characters. + # @param [String] order_by + # Field by which to sort the list. + # Acceptable values are: + # * "displayName" (default) + # * "entityStatus" + # The default sorting order is ascending. To specify descending order for + # a field, a suffix "desc" should be added to the field name. Example: + # `displayName desc`. + # @param [Fixnum] page_size + # Requested page size. Must be between `1` and `100`. If unspecified will + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + # is specified. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # next_page_token returned + # from the previous call to `ListInsertionOrders` method. If not specified, + # the first page of results will be returned. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::ListInsertionOrdersResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ListInsertionOrdersResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_advertiser_insertion_orders(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/insertionOrders', options) + command.response_representation = Google::Apis::DisplayvideoV1::ListInsertionOrdersResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::ListInsertionOrdersResponse + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing insertion order. + # Returns the updated insertion order if successful. + # @param [Fixnum] advertiser_id + # Output only. The unique ID of the advertiser the insertion order belongs to. + # @param [Fixnum] insertion_order_id + # Output only. The unique ID of the insertion order. Assigned by the system. + # @param [Google::Apis::DisplayvideoV1::InsertionOrder] insertion_order_object + # @param [String] update_mask + # Required. The mask to control which fields to update. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::InsertionOrder] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::InsertionOrder] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_advertiser_insertion_order(advertiser_id, insertion_order_id, insertion_order_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options) + command.request_representation = Google::Apis::DisplayvideoV1::InsertionOrder::Representation + command.request_object = insertion_order_object + command.response_representation = Google::Apis::DisplayvideoV1::InsertionOrder::Representation + command.response_class = Google::Apis::DisplayvideoV1::InsertionOrder + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Bulk edits targeting options under a single line item. + # The operation will delete the assigned targeting options provided in + # BulkEditLineItemAssignedTargetingOptionsRequest.delete_requests and + # then create the assigned targeting options provided in + # BulkEditLineItemAssignedTargetingOptionsRequest.create_requests . + # @param [Fixnum] advertiser_id + # Required. The ID of the advertiser the line item belongs to. + # @param [Fixnum] line_item_id + # Required. The ID of the line item the assigned targeting option will belong to. + # @param [Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsRequest] bulk_edit_line_item_assigned_targeting_options_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def bulk_edit_line_item_assigned_targeting_options(advertiser_id, line_item_id, bulk_edit_line_item_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}:bulkEditLineItemAssignedTargetingOptions', options) + command.request_representation = Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsRequest::Representation + command.request_object = bulk_edit_line_item_assigned_targeting_options_request_object + command.response_representation = Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsResponse + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['lineItemId'] = line_item_id unless line_item_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists assigned targeting options of a line item across targeting types. + # @param [Fixnum] advertiser_id + # Required. The ID of the advertiser the line item belongs to. + # @param [Fixnum] line_item_id + # Required. The ID of the line item to list assigned targeting options for. + # @param [String] filter + # Allows filtering by assigned targeting option properties. + # Supported syntax: + # * Filter expressions are made up of one or more restrictions. + # * Restrictions can be combined by the logical operator `OR` on the same + # field. + # * A restriction has the form of ``field` `operator` `value``. + # * The operator must be `EQUALS (=)`. + # * Supported fields: + # - `targetingType` + # - `inheritance` + # Examples: + # * AssignedTargetingOptions of targeting type + # TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL + # `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR + # targetingType="TARGETING_TYPE_CHANNEL"` + # * AssignedTargetingOptions with inheritance status of NOT_INHERITED or + # INHERITED_FROM_PARTNER + # `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` + # The length of this field should be no more than 500 characters. + # @param [String] order_by + # Field by which to sort the list. + # Acceptable values are: + # * `targetingType` (default) + # The default sorting order is ascending. To specify descending order for + # a field, a suffix "desc" should be added to the field name. Example: + # `targetingType desc`. + # @param [Fixnum] page_size + # Requested page size. + # The size must be an integer between `1` and `5000`. If unspecified, + # the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid + # value is specified. + # @param [String] page_token + # A token that lets the client fetch the next page of results. + # Typically, this is the value of + # next_page_token + # returned from the previous call to + # `BulkListLineItemAssignedTargetingOptions` method. + # If not specified, the first page of results will be returned. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::BulkListLineItemAssignedTargetingOptionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::BulkListLineItemAssignedTargetingOptionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def bulk_advertiser_line_item_list_line_item_assigned_targeting_options(advertiser_id, line_item_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}:bulkListLineItemAssignedTargetingOptions', options) + command.response_representation = Google::Apis::DisplayvideoV1::BulkListLineItemAssignedTargetingOptionsResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::BulkListLineItemAssignedTargetingOptionsResponse + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['lineItemId'] = line_item_id unless line_item_id.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new line item. + # Returns the newly created line item if successful. + # @param [Fixnum] advertiser_id + # Output only. The unique ID of the advertiser the line item belongs to. + # @param [Google::Apis::DisplayvideoV1::LineItem] line_item_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::LineItem] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::LineItem] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_advertiser_line_item(advertiser_id, line_item_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/lineItems', options) + command.request_representation = Google::Apis::DisplayvideoV1::LineItem::Representation + command.request_object = line_item_object + command.response_representation = Google::Apis::DisplayvideoV1::LineItem::Representation + command.response_class = Google::Apis::DisplayvideoV1::LineItem + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a line item. + # Returns error code `NOT_FOUND` if the line item does not exist. + # The line item should be archived first, i.e. set + # entity_status to `ENTITY_STATUS_ARCHIVED`, to be + # able to delete it. + # @param [Fixnum] advertiser_id + # The ID of the advertiser this line item belongs to. + # @param [Fixnum] line_item_id + # The ID of the line item we need to fetch. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_advertiser_line_item(advertiser_id, line_item_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation + command.response_class = Google::Apis::DisplayvideoV1::Empty + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['lineItemId'] = line_item_id unless line_item_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a line item. + # @param [Fixnum] advertiser_id + # Required. The ID of the advertiser this line item belongs to. + # @param [Fixnum] line_item_id + # Required. The ID of the line item to fetch. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::LineItem] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::LineItem] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_advertiser_line_item(advertiser_id, line_item_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::LineItem::Representation + command.response_class = Google::Apis::DisplayvideoV1::LineItem + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['lineItemId'] = line_item_id unless line_item_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists line items in an advertiser. + # The order is defined by the order_by + # parameter. + # If a filter by + # entity_status is not specified, line items with + # `ENTITY_STATUS_ARCHIVED` will not be included in the results. + # @param [Fixnum] advertiser_id + # Required. The ID of the advertiser to list line items for. + # @param [String] filter + # Allows filtering by line item properties. + # Supported syntax: + # * Filter expressions are made up of one or more restrictions. + # * Restrictions can be combined by `AND` or `OR` logical operators. A + # sequence of restrictions implicitly uses `AND`. + # * A restriction has the form of ``field` `operator` `value``. + # * The operator must be `EQUALS (=)`. + # * Supported fields: + # - `campaignId` + # - `insertionOrderId` + # - `entityStatus` + # - `lineItemType`. + # Examples: + # * All line items under an insertion order: `insertionOrderId="1234"` + # * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` + # and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: + # `(entityStatus="ENTITY_STATUS_ACTIVE" OR + # entityStatus="ENTITY_STATUS_PAUSED") AND + # lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` + # The length of this field should be no more than 500 characters. + # @param [String] order_by + # Field by which to sort the list. + # Acceptable values are: + # * "displayName" (default) + # * "entityStatus" + # The default sorting order is ascending. To specify descending order for + # a field, a suffix "desc" should be added to the field name. Example: + # `displayName desc`. + # @param [Fixnum] page_size + # Requested page size. Must be between `1` and `100`. If unspecified will + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + # is specified. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # next_page_token + # returned from the previous call to `ListLineItems` method. + # If not specified, the first page of results will be returned. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::ListLineItemsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ListLineItemsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_advertiser_line_items(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/lineItems', options) + command.response_representation = Google::Apis::DisplayvideoV1::ListLineItemsResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::ListLineItemsResponse + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing line item. + # Returns the updated line item if successful. + # @param [Fixnum] advertiser_id + # Output only. The unique ID of the advertiser the line item belongs to. + # @param [Fixnum] line_item_id + # Output only. The unique ID of the line item. Assigned by the system. + # @param [Google::Apis::DisplayvideoV1::LineItem] line_item_object + # @param [String] update_mask + # Required. The mask to control which fields to update. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::LineItem] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::LineItem] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_advertiser_line_item(advertiser_id, line_item_id, line_item_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}', options) + command.request_representation = Google::Apis::DisplayvideoV1::LineItem::Representation + command.request_object = line_item_object + command.response_representation = Google::Apis::DisplayvideoV1::LineItem::Representation + command.response_class = Google::Apis::DisplayvideoV1::LineItem + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['lineItemId'] = line_item_id unless line_item_id.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Assigns a targeting option to a line item. + # Returns the assigned targeting option if successful. + # @param [Fixnum] advertiser_id + # Required. The ID of the advertiser the line item belongs to. + # @param [Fixnum] line_item_id + # Required. The ID of the line item the assigned targeting option will belong to. + # @param [String] targeting_type + # Required. Identifies the type of this assigned targeting option. + # @param [Google::Apis::DisplayvideoV1::AssignedTargetingOption] assigned_targeting_option_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::AssignedTargetingOption] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::AssignedTargetingOption] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options) + command.request_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation + command.request_object = assigned_targeting_option_object + command.response_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation + command.response_class = Google::Apis::DisplayvideoV1::AssignedTargetingOption + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['lineItemId'] = line_item_id unless line_item_id.nil? + command.params['targetingType'] = targeting_type unless targeting_type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an assigned targeting option from a line item. + # @param [Fixnum] advertiser_id + # Required. The ID of the advertiser the line item belongs to. + # @param [Fixnum] line_item_id + # Required. The ID of the line item the assigned targeting option belongs to. + # @param [String] targeting_type + # Required. Identifies the type of this assigned targeting option. + # @param [String] assigned_targeting_option_id + # Required. The ID of the assigned targeting option to delete. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation + command.response_class = Google::Apis::DisplayvideoV1::Empty + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['lineItemId'] = line_item_id unless line_item_id.nil? + command.params['targetingType'] = targeting_type unless targeting_type.nil? + command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a single targeting option assigned to a line item. + # @param [Fixnum] advertiser_id + # Required. The ID of the advertiser the line item belongs to. + # @param [Fixnum] line_item_id + # Required. The ID of the line item the assigned targeting option belongs to. + # @param [String] targeting_type + # Required. Identifies the type of this assigned targeting option. + # @param [String] assigned_targeting_option_id + # Required. An identifier unique to the targeting type in this line item that + # identifies the assigned targeting option being requested. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::AssignedTargetingOption] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::AssignedTargetingOption] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation + command.response_class = Google::Apis::DisplayvideoV1::AssignedTargetingOption + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['lineItemId'] = line_item_id unless line_item_id.nil? + command.params['targetingType'] = targeting_type unless targeting_type.nil? + command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the targeting options assigned to a line item. + # @param [Fixnum] advertiser_id + # Required. The ID of the advertiser the line item belongs to. + # @param [Fixnum] line_item_id + # Required. The ID of the line item to list assigned targeting options for. + # @param [String] targeting_type + # Required. Identifies the type of assigned targeting options to list. + # @param [String] filter + # Allows filtering by assigned targeting option properties. + # Supported syntax: + # * Filter expressions are made up of one or more restrictions. + # * Restrictions can be combined by the logical operator `OR`. + # * A restriction has the form of ``field` `operator` `value``. + # * The operator must be `EQUALS (=)`. + # * Supported fields: + # - `assignedTargetingOptionId` + # - `inheritance` + # Examples: + # * AssignedTargetingOptions with ID 1 or 2 + # `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` + # * AssignedTargetingOptions with inheritance status of NOT_INHERITED or + # INHERITED_FROM_PARTNER + # `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` + # The length of this field should be no more than 500 characters. + # @param [String] order_by + # Field by which to sort the list. + # Acceptable values are: + # * `assignedTargetingOptionId` (default) + # The default sorting order is ascending. To specify descending order for + # a field, a suffix "desc" should be added to the field name. Example: + # `assignedTargetingOptionId desc`. + # @param [Fixnum] page_size + # Requested page size. Must be between `1` and `100`. If unspecified will + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + # is specified. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # next_page_token + # returned from the previous call to `ListLineItemAssignedTargetingOptions` + # method. If not specified, the first page of results will be returned. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::ListLineItemAssignedTargetingOptionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ListLineItemAssignedTargetingOptionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_advertiser_line_item_targeting_type_assigned_targeting_options(advertiser_id, line_item_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options) + command.response_representation = Google::Apis::DisplayvideoV1::ListLineItemAssignedTargetingOptionsResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::ListLineItemAssignedTargetingOptionsResponse + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['lineItemId'] = line_item_id unless line_item_id.nil? + command.params['targetingType'] = targeting_type unless targeting_type.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a location list. + # @param [Fixnum] advertiser_id + # Required. The ID of the DV360 advertiser to which the fetched location list + # belongs. + # @param [Fixnum] location_list_id + # Required. The ID of the location list to fetch. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::LocationList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::LocationList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_advertiser_location_list(advertiser_id, location_list_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/locationLists/{+locationListId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::LocationList::Representation + command.response_class = Google::Apis::DisplayvideoV1::LocationList + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['locationListId'] = location_list_id unless location_list_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists location lists based on a given advertiser id. + # @param [Fixnum] advertiser_id + # Required. The ID of the DV360 advertiser to which the fetched location lists + # belong. + # @param [String] filter + # Allows filtering by location list fields. + # Supported syntax: + # * Filter expressions are made up of one or more restrictions. + # * Restrictions can be combined by `AND` or `OR` logical operators. A + # sequence of restrictions implicitly uses `AND`. + # * A restriction has the form of ``field` `operator` `value``. + # * The operator must be `EQUALS (=)`. + # * Supported fields: + # - `locationType` + # Examples: + # * All regional location list: + # `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` + # * All proximity location list: + # `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` + # @param [String] order_by + # Field by which to sort the list. + # Acceptable values are: + # * `locationListId` (default) + # * `displayName` + # The default sorting order is ascending. To specify descending order for + # a field, a suffix "desc" should be added to the field name. Example: + # `displayName desc`. + # @param [Fixnum] page_size + # Requested page size. Must be between `1` and `100`. + # Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an + # invalid value is specified. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # next_page_token + # returned from the previous call to `ListLocationLists` method. + # If not specified, the first page of results will be returned. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::ListLocationListsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ListLocationListsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_advertiser_location_lists(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/locationLists', options) + command.response_representation = Google::Apis::DisplayvideoV1::ListLocationListsResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::ListLocationListsResponse + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a negative keyword list given an advertiser ID and a negative keyword + # list ID. + # @param [Fixnum] advertiser_id + # Required. The ID of the DV360 advertiser to which the fetched negative keyword + # list + # belongs. + # @param [Fixnum] negative_keyword_list_id + # Required. The ID of the negative keyword list to fetch. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::NegativeKeywordList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::NegativeKeywordList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::NegativeKeywordList::Representation + command.response_class = Google::Apis::DisplayvideoV1::NegativeKeywordList + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists negative keyword lists based on a given advertiser id. + # @param [Fixnum] advertiser_id + # Required. The ID of the DV360 advertiser to which the fetched negative keyword + # lists + # belong. + # @param [Fixnum] page_size + # Requested page size. Must be between `1` and `100`. + # Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an + # invalid value is specified. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # next_page_token + # returned from the previous call to `ListNegativeKeywordLists` method. + # If not specified, the first page of results will be returned. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::ListNegativeKeywordListsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ListNegativeKeywordListsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_advertiser_negative_keyword_lists(advertiser_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/negativeKeywordLists', options) + command.response_representation = Google::Apis::DisplayvideoV1::ListNegativeKeywordListsResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::ListNegativeKeywordListsResponse + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a combined audience. + # @param [Fixnum] combined_audience_id + # Required. The ID of the combined audience to fetch. + # @param [Fixnum] advertiser_id + # The ID of the advertiser that has access to the fetched combined + # audience. + # @param [Fixnum] partner_id + # The ID of the partner that has access to the fetched combined audience. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::CombinedAudience] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::CombinedAudience] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_combined_audience(combined_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/combinedAudiences/{+combinedAudienceId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::CombinedAudience::Representation + command.response_class = Google::Apis::DisplayvideoV1::CombinedAudience + command.params['combinedAudienceId'] = combined_audience_id unless combined_audience_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['partnerId'] = partner_id unless partner_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists combined audiences. + # The order is defined by the + # order_by parameter. + # @param [Fixnum] advertiser_id + # The ID of the advertiser that has access to the fetched combined + # audiences. + # @param [String] filter + # Allows filtering by combined audience fields. + # Supported syntax: + # * Filter expressions for combined audiences currently can only contain at + # most one restriction. + # * A restriction has the form of ``field` `operator` `value``. + # * The operator must be `CONTAINS (:)`. + # * Supported fields: + # - `displayName` + # Examples: + # * All combined audiences for which the display name contains "Google": + # `displayName : "Google"`. + # The length of this field should be no more than 500 characters. + # @param [String] order_by + # Field by which to sort the list. + # Acceptable values are: + # * `combinedAudienceId` (default) + # * `displayName` + # The default sorting order is ascending. To specify descending order for + # a field, a suffix "desc" should be added to the field name. Example: + # `displayName desc`. + # @param [Fixnum] page_size + # Requested page size. Must be between `1` and `100`. If unspecified will + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + # is specified. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # next_page_token + # returned from the previous call to `ListCombinedAudiences` method. + # If not specified, the first page of results will be returned. + # @param [Fixnum] partner_id + # The ID of the partner that has access to the fetched combined audiences. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::ListCombinedAudiencesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ListCombinedAudiencesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_combined_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/combinedAudiences', options) + command.response_representation = Google::Apis::DisplayvideoV1::ListCombinedAudiencesResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::ListCombinedAudiencesResponse + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['partnerId'] = partner_id unless partner_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a custom list. + # @param [Fixnum] custom_list_id + # Required. The ID of the custom list to fetch. + # @param [Fixnum] advertiser_id + # The ID of the DV360 advertiser that has access to the fetched custom + # lists. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::CustomList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::CustomList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_custom_list(custom_list_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/customLists/{+customListId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::CustomList::Representation + command.response_class = Google::Apis::DisplayvideoV1::CustomList + command.params['customListId'] = custom_list_id unless custom_list_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists custom lists. + # The order is defined by the order_by + # parameter. + # @param [Fixnum] advertiser_id + # The ID of the DV360 advertiser that has access to the fetched custom + # lists. + # @param [String] filter + # Allows filtering by custom list fields. + # Supported syntax: + # * Filter expressions for custom lists currently can only contain at + # most one restriction. + # * A restriction has the form of ``field` `operator` `value``. + # * The operator must be `CONTAINS (:)`. + # * Supported fields: + # - `displayName` + # Examples: + # * All custom lists for which the display name contains "Google": + # `displayName : "Google"`. + # The length of this field should be no more than 500 characters. + # @param [String] order_by + # Field by which to sort the list. + # Acceptable values are: + # * `customListId` (default) + # * `displayName` + # The default sorting order is ascending. To specify descending order for + # a field, a suffix "desc" should be added to the field name. Example: + # `displayName desc`. + # @param [Fixnum] page_size + # Requested page size. Must be between `1` and `100`. If unspecified will + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + # is specified. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # next_page_token + # returned from the previous call to `ListCustomLists` method. + # If not specified, the first page of results will be returned. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::ListCustomListsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ListCustomListsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_custom_lists(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/customLists', options) + command.response_representation = Google::Apis::DisplayvideoV1::ListCustomListsResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::ListCustomListsResponse + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a first and third party audience. + # @param [Fixnum] first_and_third_party_audience_id + # Required. The ID of the first and third party audience to fetch. + # @param [Fixnum] advertiser_id + # The ID of the advertiser that has access to the fetched first and + # third party audience. + # @param [Fixnum] partner_id + # The ID of the partner that has access to the fetched first and + # third party audience. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudience] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudience] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_first_and_third_party_audience(first_and_third_party_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudience::Representation + command.response_class = Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudience + command.params['firstAndThirdPartyAudienceId'] = first_and_third_party_audience_id unless first_and_third_party_audience_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['partnerId'] = partner_id unless partner_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists first and third party audiences. + # The order is defined by the + # order_by parameter. + # @param [Fixnum] advertiser_id + # The ID of the advertiser that has access to the fetched first and + # third party audiences. + # @param [String] filter + # Allows filtering by first and third party audience fields. + # Supported syntax: + # * Filter expressions for first and third party audiences currently can + # only contain at most one restriction. + # * A restriction has the form of ``field` `operator` `value``. + # * The operator must be `CONTAINS (:)`. + # * Supported fields: + # - `displayName` + # Examples: + # * All first and third party audiences for which the display name contains + # "Google": `displayName : "Google"`. + # The length of this field should be no more than 500 characters. + # @param [String] order_by + # Field by which to sort the list. + # Acceptable values are: + # * `firstAndThirdPartyAudienceId` (default) + # * `displayName` + # The default sorting order is ascending. To specify descending order for + # a field, a suffix "desc" should be added to the field name. Example: + # `displayName desc`. + # @param [Fixnum] page_size + # Requested page size. Must be between `1` and `100`. If unspecified will + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + # is specified. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # next_page_token + # returned from the previous call to `ListFirstAndThirdPartyAudiences` + # method. If not specified, the first page of results will be returned. + # @param [Fixnum] partner_id + # The ID of the partner that has access to the fetched first and + # third party audiences. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::ListFirstAndThirdPartyAudiencesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ListFirstAndThirdPartyAudiencesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_first_and_third_party_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/firstAndThirdPartyAudiences', options) + command.response_representation = Google::Apis::DisplayvideoV1::ListFirstAndThirdPartyAudiencesResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::ListFirstAndThirdPartyAudiencesResponse + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['partnerId'] = partner_id unless partner_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a Floodlight group. + # @param [Fixnum] floodlight_group_id + # Required. The ID of the Floodlight group to fetch. + # @param [Fixnum] partner_id + # Required. The partner context by which the Floodlight group is being accessed. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::FloodlightGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::FloodlightGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_floodlight_group(floodlight_group_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/floodlightGroups/{+floodlightGroupId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::FloodlightGroup::Representation + command.response_class = Google::Apis::DisplayvideoV1::FloodlightGroup + command.params['floodlightGroupId'] = floodlight_group_id unless floodlight_group_id.nil? + command.query['partnerId'] = partner_id unless partner_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing Floodlight group. + # Returns the updated Floodlight group if successful. + # @param [Fixnum] floodlight_group_id + # Output only. The unique ID of the Floodlight group. Assigned by the system. + # @param [Google::Apis::DisplayvideoV1::FloodlightGroup] floodlight_group_object + # @param [Fixnum] partner_id + # Required. The partner context by which the Floodlight group is being accessed. + # @param [String] update_mask + # Required. The mask to control which fields to update. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::FloodlightGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::FloodlightGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_floodlight_group(floodlight_group_id, floodlight_group_object = nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/floodlightGroups/{floodlightGroupId}', options) + command.request_representation = Google::Apis::DisplayvideoV1::FloodlightGroup::Representation + command.request_object = floodlight_group_object + command.response_representation = Google::Apis::DisplayvideoV1::FloodlightGroup::Representation + command.response_class = Google::Apis::DisplayvideoV1::FloodlightGroup + command.params['floodlightGroupId'] = floodlight_group_id unless floodlight_group_id.nil? + command.query['partnerId'] = partner_id unless partner_id.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a Google audience. + # @param [Fixnum] google_audience_id + # Required. The ID of the Google audience to fetch. + # @param [Fixnum] advertiser_id + # The ID of the advertiser that has access to the fetched Google audience. + # @param [Fixnum] partner_id + # The ID of the partner that has access to the fetched Google audience. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::GoogleAudience] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::GoogleAudience] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_google_audience(google_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/googleAudiences/{+googleAudienceId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::GoogleAudience::Representation + command.response_class = Google::Apis::DisplayvideoV1::GoogleAudience + command.params['googleAudienceId'] = google_audience_id unless google_audience_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['partnerId'] = partner_id unless partner_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists Google audiences. + # The order is defined by the order_by + # parameter. + # @param [Fixnum] advertiser_id + # The ID of the advertiser that has access to the fetched Google audiences. + # @param [String] filter + # Allows filtering by Google audience fields. + # Supported syntax: + # * Filter expressions for Google audiences currently can only contain at + # most one restriction. + # * A restriction has the form of ``field` `operator` `value``. + # * The operator must be `CONTAINS (:)`. + # * Supported fields: + # - `displayName` + # Examples: + # * All Google audiences for which the display name contains "Google": + # `displayName : "Google"`. + # The length of this field should be no more than 500 characters. + # @param [String] order_by + # Field by which to sort the list. + # Acceptable values are: + # * `googleAudienceId` (default) + # * `displayName` + # The default sorting order is ascending. To specify descending order for + # a field, a suffix "desc" should be added to the field name. Example: + # `displayName desc`. + # @param [Fixnum] page_size + # Requested page size. Must be between `1` and `100`. If unspecified will + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + # is specified. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # next_page_token + # returned from the previous call to `ListGoogleAudiences` method. + # If not specified, the first page of results will be returned. + # @param [Fixnum] partner_id + # The ID of the partner that has access to the fetched Google audiences. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::ListGoogleAudiencesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ListGoogleAudiencesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_google_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/googleAudiences', options) + command.response_representation = Google::Apis::DisplayvideoV1::ListGoogleAudiencesResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::ListGoogleAudiencesResponse + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['partnerId'] = partner_id unless partner_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets an inventory source group. + # @param [Fixnum] inventory_source_group_id + # Required. The ID of the inventory source group to fetch. + # @param [Fixnum] advertiser_id + # The ID of the advertiser that has access to the inventory source group. + # If an inventory source group is partner-owned, only advertisers to which + # the group is explicitly shared can access the group. + # @param [Fixnum] partner_id + # The ID of the partner that has access to the inventory source group. + # A partner cannot access an advertiser-owned inventory source group. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::InventorySourceGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::InventorySourceGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_inventory_source_group(inventory_source_group_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/inventorySourceGroups/{+inventorySourceGroupId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::InventorySourceGroup::Representation + command.response_class = Google::Apis::DisplayvideoV1::InventorySourceGroup + command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['partnerId'] = partner_id unless partner_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists inventory source groups that are accessible to the current user. + # The order is defined by the + # order_by parameter. + # @param [Fixnum] advertiser_id + # The ID of the advertiser that has access to the inventory source group. + # If an inventory source group is partner-owned, only advertisers to which + # the group is explicitly shared can access the group. + # @param [String] filter + # Allows filtering by inventory source group properties. + # Supported syntax: + # * Filter expressions are made up of one or more restrictions. + # * Restrictions can be combined by the logical operator `OR`. + # * A restriction has the form of ``field` `operator` `value``. + # * The operator must be `EQUALS (=)`. + # * Supported fields: + # - `inventorySourceGroupId` + # The length of this field should be no more than 500 characters. + # @param [String] order_by + # Field by which to sort the list. + # Acceptable values are: + # * `displayName` (default) + # * `inventorySourceGroupId` + # The default sorting order is ascending. To specify descending order for + # a field, a suffix "desc" should be added to the field name. For example, + # `displayName desc`. + # @param [Fixnum] page_size + # Requested page size. Must be between `1` and `100`. If unspecified will + # default to `100`. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # next_page_token + # returned from the previous call to `ListInventorySources` method. + # If not specified, the first page of results will be returned. + # @param [Fixnum] partner_id + # The ID of the partner that has access to the inventory source group. + # A partner cannot access advertiser-owned inventory source groups. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::ListInventorySourceGroupsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ListInventorySourceGroupsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_inventory_source_groups(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/inventorySourceGroups', options) + command.response_representation = Google::Apis::DisplayvideoV1::ListInventorySourceGroupsResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::ListInventorySourceGroupsResponse + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['partnerId'] = partner_id unless partner_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets an inventory source. + # @param [Fixnum] inventory_source_id + # Required. The ID of the inventory source to fetch. + # @param [Fixnum] partner_id + # Required. The ID of the DV360 partner to which the fetched inventory source + # is permissioned. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::InventorySource] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::InventorySource] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_inventory_source(inventory_source_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/inventorySources/{+inventorySourceId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::InventorySource::Representation + command.response_class = Google::Apis::DisplayvideoV1::InventorySource + command.params['inventorySourceId'] = inventory_source_id unless inventory_source_id.nil? + command.query['partnerId'] = partner_id unless partner_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists inventory sources that are accessible to the current user. + # The order is defined by the + # order_by parameter. + # If a filter by + # entity_status is not + # specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` + # will not be included in the results. + # @param [Fixnum] advertiser_id + # The ID of the advertiser that has access to the inventory source. + # @param [String] filter + # Allows filtering by inventory source properties. + # Supported syntax: + # * Filter expressions are made up of one or more restrictions. + # * Restrictions can be combined by `AND` or `OR` logical operators. A + # sequence of restrictions implicitly uses `AND`. + # * A restriction has the form of ``field` `operator` `value``. + # * The operator must be `EQUALS (=)`. + # * Supported fields: + # - `status.entityStatus` + # - `commitment` + # - `deliveryMethod` + # - `rateDetails.rateType` + # - `exchange` + # Examples: + # * All active inventory sources: + # `status.entityStatus="ENTITY_STATUS_ACTIVE"` + # * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: + # `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` + # The length of this field should be no more than 500 characters. + # @param [String] order_by + # Field by which to sort the list. + # Acceptable values are: + # * `displayName` (default) + # The default sorting order is ascending. To specify descending order for + # a field, a suffix "desc" should be added to the field name. For example, + # `displayName desc`. + # @param [Fixnum] page_size + # Requested page size. Must be between `1` and `100`. If unspecified will + # default to `100`. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # next_page_token + # returned from the previous call to `ListInventorySources` method. + # If not specified, the first page of results will be returned. + # @param [Fixnum] partner_id + # The ID of the partner that has access to the inventory source. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::ListInventorySourcesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ListInventorySourcesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_inventory_sources(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/inventorySources', options) + command.response_representation = Google::Apis::DisplayvideoV1::ListInventorySourcesResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::ListInventorySourcesResponse + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['partnerId'] = partner_id unless partner_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Downloads media. Download is supported on the URI `/download/`resource_name=**` # ?alt=media.` # **Note**: Download requests will not be successful without including `alt= @@ -89,6 +2550,110 @@ module Google execute_or_queue_command(command, &block) end + # Gets a channel for a partner or advertiser. + # @param [Fixnum] partner_id + # The ID of the partner that owns the fetched channel. + # @param [Fixnum] channel_id + # Required. The ID of the channel to fetch. + # @param [Fixnum] advertiser_id + # The ID of the advertiser that owns the fetched channel. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::Channel] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Channel] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_partner_channel(partner_id, channel_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/partners/{+partnerId}/channels/{+channelId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::Channel::Representation + command.response_class = Google::Apis::DisplayvideoV1::Channel + command.params['partnerId'] = partner_id unless partner_id.nil? + command.params['channelId'] = channel_id unless channel_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists channels for a partner or advertiser. + # @param [Fixnum] partner_id + # The ID of the partner that owns the channels. + # @param [Fixnum] advertiser_id + # The ID of the advertiser that owns the channels. + # @param [String] filter + # Allows filtering by channel fields. + # Supported syntax: + # * Filter expressions for channel currently can only contain at most one + # * restriction. + # * A restriction has the form of ``field` `operator` `value``. + # * The operator must be `CONTAINS (:)`. + # * Supported fields: + # - `displayName` + # Examples: + # * All channels for which the display name contains "google": + # `displayName : "google"`. + # The length of this field should be no more than 500 characters. + # @param [String] order_by + # Field by which to sort the list. + # Acceptable values are: + # * `displayName` (default) + # * `channelId` + # The default sorting order is ascending. To specify descending order for a + # field, a suffix " desc" should be added to the field name. Example: + # `displayName desc`. + # @param [Fixnum] page_size + # Requested page size. Must be between `1` and `100`. If unspecified will + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + # is specified. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # next_page_token returned from the + # previous call to `ListChannels` method. If not specified, the first page + # of results will be returned. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::ListChannelsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ListChannelsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_partner_channels(partner_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/partners/{+partnerId}/channels', options) + command.response_representation = Google::Apis::DisplayvideoV1::ListChannelsResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::ListChannelsResponse + command.params['partnerId'] = partner_id unless partner_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Creates an SDF Download Task. Returns an # Operation. # An SDF Download Task is a long-running, asynchronous operation. The @@ -163,6 +2728,106 @@ module Google command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end + + # Gets a single targeting option. + # @param [String] targeting_type + # Required. The type of targeting option to retrieve. + # @param [String] targeting_option_id + # Required. The ID of the of targeting option to retrieve. + # @param [Fixnum] advertiser_id + # Required. The Advertiser this request is being made in the context of. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::TargetingOption] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::TargetingOption] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_targeting_type_targeting_option(targeting_type, targeting_option_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/targetingTypes/{+targetingType}/targetingOptions/{+targetingOptionId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::TargetingOption::Representation + command.response_class = Google::Apis::DisplayvideoV1::TargetingOption + command.params['targetingType'] = targeting_type unless targeting_type.nil? + command.params['targetingOptionId'] = targeting_option_id unless targeting_option_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists targeting options of a given type. + # @param [String] targeting_type + # Required. The type of targeting option to be listed. + # @param [Fixnum] advertiser_id + # Required. The Advertiser this request is being made in the context of. + # @param [String] filter + # Allows filtering by targeting option properties. + # Supported syntax: + # * Filter expressions are made up of one or more restrictions. + # * Restrictions can be combined by `OR` logical operators. + # * A restriction has the form of ``field` `operator` `value``. + # * The operator must be "=" (equal sign). + # * Supported fields: + # - `targetingOptionId` + # The length of this field should be no more than 500 characters. + # @param [String] order_by + # Field by which to sort the list. + # Acceptable values are: + # * `targetingOptionId` (default) + # The default sorting order is ascending. To specify descending order for + # a field, a suffix "desc" should be added to the field name. + # Example: `targetingOptionId desc`. + # @param [Fixnum] page_size + # Requested page size. Must be between `1` and `100`. If unspecified will + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + # is specified. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # next_page_token + # returned from the previous call to `ListTargetingOptions` method. + # If not specified, the first page of results will be returned. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::ListTargetingOptionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ListTargetingOptionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_targeting_type_targeting_options(targeting_type, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/targetingTypes/{+targetingType}/targetingOptions', options) + command.response_representation = Google::Apis::DisplayvideoV1::ListTargetingOptionsResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::ListTargetingOptionsResponse + command.params['targetingType'] = targeting_type unless targeting_type.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end protected diff --git a/generated/google/apis/dlp_v2.rb b/generated/google/apis/dlp_v2.rb index 4f45e6079..b155b4e8e 100644 --- a/generated/google/apis/dlp_v2.rb +++ b/generated/google/apis/dlp_v2.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/dlp/docs/ module DlpV2 VERSION = 'V2' - REVISION = '20200405' + REVISION = '20200505' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dlp_v2/classes.rb b/generated/google/apis/dlp_v2/classes.rb index a484ce09c..3f7a3699b 100644 --- a/generated/google/apis/dlp_v2/classes.rb +++ b/generated/google/apis/dlp_v2/classes.rb @@ -6037,7 +6037,12 @@ module Google class GooglePrivacyDlpV2TableLocation include Google::Apis::Core::Hashable - # The zero-based index of the row where the finding is located. + # The zero-based index of the row where the finding is located. Only + # populated for resources that have a natural ordering, not BigQuery. In + # BigQuery, to identify the row a finding came from, populate + # BigQueryOptions.identifying_fields with your primary key column names and + # when you store the findings the value of those columns will be stored + # inside of Finding. # Corresponds to the JSON property `rowIndex` # @return [Fixnum] attr_accessor :row_index diff --git a/generated/google/apis/drive_v2.rb b/generated/google/apis/drive_v2.rb index 4b9968114..17546b6cb 100644 --- a/generated/google/apis/drive_v2.rb +++ b/generated/google/apis/drive_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/drive/ module DriveV2 VERSION = 'V2' - REVISION = '20200326' + REVISION = '20200413' # See, edit, create, and delete all of your Google Drive files AUTH_DRIVE = 'https://www.googleapis.com/auth/drive' diff --git a/generated/google/apis/drive_v2/classes.rb b/generated/google/apis/drive_v2/classes.rb index d30a6e3c4..0159ecc1c 100644 --- a/generated/google/apis/drive_v2/classes.rb +++ b/generated/google/apis/drive_v2/classes.rb @@ -3022,6 +3022,7 @@ module Google # The time at which this permission will expire (RFC 3339 date-time). Expiration # dates have the following restrictions: + # - They cannot be set on shared drive items # - They can only be set on user and group permissions # - The date must be in the future # - The date cannot be more than a year in the future diff --git a/generated/google/apis/drive_v2/service.rb b/generated/google/apis/drive_v2/service.rb index 8e72ea481..a4348ca80 100644 --- a/generated/google/apis/drive_v2/service.rb +++ b/generated/google/apis/drive_v2/service.rb @@ -179,7 +179,7 @@ module Google # @param [String] change_id # The ID of the change. # @param [String] drive_id - # The shared drive from which the change will be returned. + # The shared drive from which the change is returned. # @param [Boolean] supports_all_drives # Deprecated - Whether the requesting application supports both My Drives and # shared drives. This parameter will only be effective until June 1, 2020. @@ -225,7 +225,7 @@ module Google # Gets the starting pageToken for listing future changes. # @param [String] drive_id # The ID of the shared drive for which the starting pageToken for listing future - # changes from that shared drive will be returned. + # changes from that shared drive is returned. # @param [Boolean] supports_all_drives # Deprecated - Whether the requesting application supports both My Drives and # shared drives. This parameter will only be effective until June 1, 2020. @@ -269,9 +269,9 @@ module Google # Lists the changes for a user or shared drive. # @param [String] drive_id - # The shared drive from which changes will be returned. If specified the change - # IDs will be reflective of the shared drive; use the combined drive ID and - # change ID as an identifier. + # The shared drive from which changes are returned. If specified the change IDs + # will be reflective of the shared drive; use the combined drive ID and change + # ID as an identifier. # @param [Boolean] include_corpus_removals # Whether changes should include the file resource if the file is still # accessible by the user at the time of the request, even when a file was @@ -283,12 +283,11 @@ module Google # @param [Boolean] include_items_from_all_drives # Deprecated - Whether both My Drive and shared drive items should be included # in results. This parameter will only be effective until June 1, 2020. - # Afterwards shared drive items will be included in the results. + # Afterwards shared drive items are included in the results. # @param [Boolean] include_subscribed # Whether to include changes outside the My Drive hierarchy in the result. When # set to false, changes to files such as those in the Application Data folder or - # shared files which have not been added to My Drive will be omitted from the - # result. + # shared files which have not been added to My Drive are omitted from the result. # @param [Boolean] include_team_drive_items # Deprecated use includeItemsFromAllDrives instead. # @param [Fixnum] max_results @@ -355,9 +354,9 @@ module Google # Subscribe to changes for a user. # @param [Google::Apis::DriveV2::Channel] channel_object # @param [String] drive_id - # The shared drive from which changes will be returned. If specified the change - # IDs will be reflective of the shared drive; use the combined drive ID and - # change ID as an identifier. + # The shared drive from which changes are returned. If specified the change IDs + # will be reflective of the shared drive; use the combined drive ID and change + # ID as an identifier. # @param [Boolean] include_corpus_removals # Whether changes should include the file resource if the file is still # accessible by the user at the time of the request, even when a file was @@ -369,12 +368,11 @@ module Google # @param [Boolean] include_items_from_all_drives # Deprecated - Whether both My Drive and shared drive items should be included # in results. This parameter will only be effective until June 1, 2020. - # Afterwards shared drive items will be included in the results. + # Afterwards shared drive items are included in the results. # @param [Boolean] include_subscribed # Whether to include changes outside the My Drive hierarchy in the result. When # set to false, changes to files such as those in the Application Data folder or - # shared files which have not been added to My Drive will be omitted from the - # result. + # shared files which have not been added to My Drive are omitted from the result. # @param [Boolean] include_team_drive_items # Deprecated use includeItemsFromAllDrives instead. # @param [Fixnum] max_results @@ -478,9 +476,9 @@ module Google # The ID of the child. # @param [Boolean] enforce_single_parent # Set to true to opt in to API behavior that aims for all items to have exactly - # one parent. This parameter will only take effect if the item is not in a - # shared drive. If the item's last parent is removed, the item will be placed - # under its owner's root. + # one parent. This parameter only takes effect if the item is not in a shared + # drive. If the item's last parent is removed, the item is placed under its + # owner's root. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -553,12 +551,11 @@ module Google # @param [Google::Apis::DriveV2::ChildReference] child_reference_object # @param [Boolean] enforce_single_parent # Set to true to opt in to API behavior that aims for all items to have exactly - # one parent. This parameter will only take effect if the item is not in a - # shared drive. If the child's owner makes the request, the child will be - # removed from all current folders and placed in the requested folder. Any other - # requests that increase the number of the child's parents will fail, except - # when the canAddMyDriveParent file capability is true and a single parent is - # being added. + # one parent. This parameter only takes effect if the item is not in a shared + # drive. If the child's owner makes the request, the child is removed from all + # current folders and placed in the requested folder. Any other requests that + # increase the number of the child's parents fail, except when the + # canAddMyDriveParent file capability is true and a single parent is being added. # @param [Boolean] supports_all_drives # Deprecated - Whether the requesting application supports both My Drives and # shared drives. This parameter will only be effective until June 1, 2020. @@ -1156,8 +1153,8 @@ module Google # Whether to convert this file to the corresponding Google Docs format. # @param [Boolean] enforce_single_parent # Set to true to opt in to API behavior that aims for all items to have exactly - # one parent. This parameter will only take effect if the item is not in a - # shared drive. Requests that specify more than one parent will fail. + # one parent. This parameter only takes effect if the item is not in a shared + # drive. Requests that specify more than one parent fail. # @param [Boolean] ocr # Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. # @param [String] ocr_language @@ -1436,8 +1433,8 @@ module Google # Whether to convert this file to the corresponding Google Docs format. # @param [Boolean] enforce_single_parent # Set to true to opt in to API behavior that aims for all items to have exactly - # one parent. This parameter will only take effect if the item is not in a - # shared drive. Requests that specify more than one parent will fail. + # one parent. This parameter only takes effect if the item is not in a shared + # drive. Requests that specify more than one parent fail. # @param [Boolean] ocr # Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. # @param [String] ocr_language @@ -1609,12 +1606,11 @@ module Google # This parameter is deprecated and has no function. # @param [Boolean] enforce_single_parent # Set to true to opt in to API behavior that aims for all items to have exactly - # one parent. This parameter will only take effect if the item is not in a - # shared drive. If the item's owner makes a request to add a single parent, the - # item will be removed from all current folders and placed in the requested - # folder. Other requests that increase the number of parents will fail, except - # when the canAddMyDriveParent file capability is true and a single parent is - # being added. + # one parent. This parameter only takes effect if the item is not in a shared + # drive. If the item's owner makes a request to add a single parent, the item is + # removed from all current folders and placed in the requested folder. Other + # requests that increase the number of parents fail, except when the + # canAddMyDriveParent file capability is true and a single parent is being added. # @param [String] modified_date_behavior # Determines the behavior in which modifiedDate is updated. This overrides # setModifiedDate. @@ -1835,12 +1831,11 @@ module Google # This parameter is deprecated and has no function. # @param [Boolean] enforce_single_parent # Set to true to opt in to API behavior that aims for all items to have exactly - # one parent. This parameter will only take effect if the item is not in a - # shared drive. If the item's owner makes a request to add a single parent, the - # item will be removed from all current folders and placed in the requested - # folder. Other requests that increase the number of parents will fail, except - # when the canAddMyDriveParent file capability is true and a single parent is - # being added. + # one parent. This parameter only takes effect if the item is not in a shared + # drive. If the item's owner makes a request to add a single parent, the item is + # removed from all current folders and placed in the requested folder. Other + # requests that increase the number of parents fail, except when the + # canAddMyDriveParent file capability is true and a single parent is being added. # @param [String] modified_date_behavior # Determines the behavior in which modifiedDate is updated. This overrides # setModifiedDate. @@ -2010,9 +2005,9 @@ module Google # The ID of the parent. # @param [Boolean] enforce_single_parent # Set to true to opt in to API behavior that aims for all items to have exactly - # one parent. This parameter will only take effect if the item is not in a - # shared drive. If the item's last parent is removed, the item will be placed - # under its owner's root. + # one parent. This parameter only takes effect if the item is not in a shared + # drive. If the item's last parent is removed, the item is placed under its + # owner's root. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2085,12 +2080,11 @@ module Google # @param [Google::Apis::DriveV2::ParentReference] parent_reference_object # @param [Boolean] enforce_single_parent # Set to true to opt in to API behavior that aims for all items to have exactly - # one parent. This parameter will only take effect if the item is not in a - # shared drive. If the child's owner makes the request, the child will be - # removed from all current folders and placed in the requested folder. Any other - # requests that increase the number of the child's parents will fail, except - # when the canAddMyDriveParent file capability is true and a single parent is - # being added. + # one parent. This parameter only takes effect if the item is not in a shared + # drive. If the child's owner makes the request, the child is removed from all + # current folders and placed in the requested folder. Any other requests that + # increase the number of the child's parents fail, except when the + # canAddMyDriveParent file capability is true and a single parent is being added. # @param [Boolean] supports_all_drives # Deprecated - Whether the requesting application supports both My Drives and # shared drives. This parameter will only be effective until June 1, 2020. @@ -2304,16 +2298,16 @@ module Google # A plain text custom message to include in notification emails. # @param [Boolean] enforce_single_parent # Set to true to opt in to API behavior that aims for all items to have exactly - # one parent. This parameter will only take effect if the item is not in a - # shared drive. See moveToNewOwnersRoot for details. + # one parent. This parameter only takes effect if the item is not in a shared + # drive. See moveToNewOwnersRoot for details. # @param [Boolean] move_to_new_owners_root - # This parameter will only take effect if the item is not in a shared drive and - # the request is attempting to transfer the ownership of the item. When set to - # true, the item will be moved to the new owner's My Drive root folder and all - # prior parents removed. If set to false, when enforceSingleParent=true, parents - # are not changed. If set to false, when enforceSingleParent=false, existing - # parents are not changed; however, the file will be added to the new owner's My - # Drive root folder, unless it is already in the new owner's My Drive. + # This parameter only takes effect if the item is not in a shared drive and the + # request is attempting to transfer the ownership of the item. When set to true, + # the item will be moved to the new owner's My Drive root folder and all prior + # parents removed. If set to false, when enforceSingleParent=true, parents are + # not changed. If set to false, when enforceSingleParent=false, existing parents + # are not changed; however, the file will be added to the new owner's My Drive + # root folder, unless it is already in the new owner's My Drive. # @param [Boolean] send_notification_emails # Whether to send notification emails when sharing to users or groups. This # parameter is ignored and an email is sent if the role is owner. diff --git a/generated/google/apis/drive_v3.rb b/generated/google/apis/drive_v3.rb index 58f25ef15..a3cb2a47b 100644 --- a/generated/google/apis/drive_v3.rb +++ b/generated/google/apis/drive_v3.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/drive/ module DriveV3 VERSION = 'V3' - REVISION = '20200326' + REVISION = '20200413' # See, edit, create, and delete all of your Google Drive files AUTH_DRIVE = 'https://www.googleapis.com/auth/drive' diff --git a/generated/google/apis/drive_v3/service.rb b/generated/google/apis/drive_v3/service.rb index 4364c088b..45920b2a7 100644 --- a/generated/google/apis/drive_v3/service.rb +++ b/generated/google/apis/drive_v3/service.rb @@ -85,7 +85,7 @@ module Google # Gets the starting pageToken for listing future changes. # @param [String] drive_id # The ID of the shared drive for which the starting pageToken for listing future - # changes from that shared drive will be returned. + # changes from that shared drive is returned. # @param [Boolean] supports_all_drives # Deprecated - Whether the requesting application supports both My Drives and # shared drives. This parameter will only be effective until June 1, 2020. @@ -133,9 +133,9 @@ module Google # be set to the value of 'nextPageToken' from the previous response or to the # response from the getStartPageToken method. # @param [String] drive_id - # The shared drive from which changes will be returned. If specified the change - # IDs will be reflective of the shared drive; use the combined drive ID and - # change ID as an identifier. + # The shared drive from which changes are returned. If specified the change IDs + # will be reflective of the shared drive; use the combined drive ID and change + # ID as an identifier. # @param [Boolean] include_corpus_removals # Whether changes should include the file resource if the file is still # accessible by the user at the time of the request, even when a file was @@ -144,7 +144,7 @@ module Google # @param [Boolean] include_items_from_all_drives # Deprecated - Whether both My Drive and shared drive items should be included # in results. This parameter will only be effective until June 1, 2020. - # Afterwards shared drive items will be included in the results. + # Afterwards shared drive items are included in the results. # @param [Boolean] include_removed # Whether to include changes indicating that items have been removed from the # list of changes, for example by deletion or loss of access. @@ -215,9 +215,9 @@ module Google # response from the getStartPageToken method. # @param [Google::Apis::DriveV3::Channel] channel_object # @param [String] drive_id - # The shared drive from which changes will be returned. If specified the change - # IDs will be reflective of the shared drive; use the combined drive ID and - # change ID as an identifier. + # The shared drive from which changes are returned. If specified the change IDs + # will be reflective of the shared drive; use the combined drive ID and change + # ID as an identifier. # @param [Boolean] include_corpus_removals # Whether changes should include the file resource if the file is still # accessible by the user at the time of the request, even when a file was @@ -226,7 +226,7 @@ module Google # @param [Boolean] include_items_from_all_drives # Deprecated - Whether both My Drive and shared drive items should be included # in results. This parameter will only be effective until June 1, 2020. - # Afterwards shared drive items will be included in the results. + # Afterwards shared drive items are included in the results. # @param [Boolean] include_removed # Whether to include changes indicating that items have been removed from the # list of changes, for example by deletion or loss of access. @@ -787,8 +787,8 @@ module Google # @param [Google::Apis::DriveV3::File] file_object # @param [Boolean] enforce_single_parent # Set to true to opt in to API behavior that aims for all items to have exactly - # one parent. This parameter will only take effect if the item is not in a - # shared drive. Requests that specify more than one parent will fail. + # one parent. This parameter only takes effect if the item is not in a shared + # drive. Requests that specify more than one parent fail. # @param [Boolean] ignore_default_visibility # Whether to ignore the domain's default visibility settings for the created # file. Domain administrators can choose to make all uploaded files visible to @@ -849,8 +849,8 @@ module Google # @param [Google::Apis::DriveV3::File] file_object # @param [Boolean] enforce_single_parent # Set to true to opt in to API behavior that aims for all items to have exactly - # one parent. This parameter will only take effect if the item is not in a - # shared drive. Requests that specify more than one parent will fail. + # one parent. This parameter only takes effect if the item is not in a shared + # drive. Requests that specify more than one parent fail. # @param [Boolean] ignore_default_visibility # Whether to ignore the domain's default visibility settings for the created # file. Domain administrators can choose to make all uploaded files visible to @@ -1132,7 +1132,7 @@ module Google # @param [Boolean] include_items_from_all_drives # Deprecated - Whether both My Drive and shared drive items should be included # in results. This parameter will only be effective until June 1, 2020. - # Afterwards shared drive items will be included in the results. + # Afterwards shared drive items are included in the results. # @param [Boolean] include_team_drive_items # Deprecated use includeItemsFromAllDrives instead. # @param [String] order_by @@ -1213,12 +1213,11 @@ module Google # A comma-separated list of parent IDs to add. # @param [Boolean] enforce_single_parent # Set to true to opt in to API behavior that aims for all items to have exactly - # one parent. This parameter will only take effect if the item is not in a - # shared drive. If the item's owner makes a request to add a single parent, the - # item will be removed from all current folders and placed in the requested - # folder. Other requests that increase the number of parents will fail, except - # when the canAddMyDriveParent file capability is true and a single parent is - # being added. + # one parent. This parameter only takes effect if the item is not in a shared + # drive. If the item's owner makes a request to add a single parent, the item is + # removed from all current folders and placed in the requested folder. Other + # requests that increase the number of parents fail, except when the + # canAddMyDriveParent file capability is true and a single parent is being added. # @param [Boolean] keep_revision_forever # Whether to set the 'keepForever' field in the new head revision. This is only # applicable to files with binary content in Google Drive. Only 200 revisions @@ -1349,16 +1348,16 @@ module Google # A plain text custom message to include in the notification email. # @param [Boolean] enforce_single_parent # Set to true to opt in to API behavior that aims for all items to have exactly - # one parent. This parameter will only take effect if the item is not in a - # shared drive. See moveToNewOwnersRoot for details. + # one parent. This parameter only takes effect if the item is not in a shared + # drive. See moveToNewOwnersRoot for details. # @param [Boolean] move_to_new_owners_root - # This parameter will only take effect if the item is not in a shared drive and - # the request is attempting to transfer the ownership of the item. When set to - # true, the item will be moved to the new owner's My Drive root folder and all - # prior parents removed. If set to false, when enforceSingleParent=true, parents - # are not changed. If set to false, when enforceSingleParent=false, existing - # parents are not changed; however, the file will be added to the new owner's My - # Drive root folder, unless it is already in the new owner's My Drive. + # This parameter only takes effect if the item is not in a shared drive and the + # request is attempting to transfer the ownership of the item. When set to true, + # the item is moved to the new owner's My Drive root folder and all prior + # parents removed. If set to false, when enforceSingleParent=true, parents are + # not changed. If set to false, when enforceSingleParent=false, existing parents + # are not changed; however, the file will be added to the new owner's My Drive + # root folder, unless it is already in the new owner's My Drive. # @param [Boolean] send_notification_email # Whether to send a notification email when sharing to users or groups. This # defaults to true for users and groups, and is not allowed for other requests. diff --git a/generated/google/apis/driveactivity_v2.rb b/generated/google/apis/driveactivity_v2.rb index faee7c8ac..001590b8c 100644 --- a/generated/google/apis/driveactivity_v2.rb +++ b/generated/google/apis/driveactivity_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/drive/activity/ module DriveactivityV2 VERSION = 'V2' - REVISION = '20200218' + REVISION = '20200428' # View and add to the activity record of files in your Google Drive AUTH_DRIVE_ACTIVITY = 'https://www.googleapis.com/auth/drive.activity' diff --git a/generated/google/apis/driveactivity_v2/classes.rb b/generated/google/apis/driveactivity_v2/classes.rb index c369f5122..25c1c86c7 100644 --- a/generated/google/apis/driveactivity_v2/classes.rb +++ b/generated/google/apis/driveactivity_v2/classes.rb @@ -1125,7 +1125,7 @@ module Google # parentheses. # Examples: # - detail.action_detail_case: RENAME - # - detail.action_detail_case:(CREATE UPLOAD) + # - detail.action_detail_case:(CREATE EDIT) # - -detail.action_detail_case:MOVE # Corresponds to the JSON property `filter` # @return [String] @@ -1137,14 +1137,18 @@ module Google # @return [String] attr_accessor :item_name - # The requested number of activity to return. If not set, a default value - # will be used. + # The miminum number of activities desired in the response; the server will + # attempt to return at least this quanitity. The server may also return fewer + # activities if it has a partial response ready before the request times out. + # If not set, a default value is used. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size - # The next_page_token value returned from a previous QueryDriveActivity - # request, if any. + # The token identifying which page of results to return. Set this to the + # next_page_token value returned from a previous query to obtain the + # following page of results. If not set, the first page of results will be + # returned. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token diff --git a/generated/google/apis/file_v1.rb b/generated/google/apis/file_v1.rb index f455f590c..7dcfa86fb 100644 --- a/generated/google/apis/file_v1.rb +++ b/generated/google/apis/file_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/filestore/ module FileV1 VERSION = 'V1' - REVISION = '20200320' + REVISION = '20200413' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/file_v1/classes.rb b/generated/google/apis/file_v1/classes.rb index ec484d12b..e09e7697f 100644 --- a/generated/google/apis/file_v1/classes.rb +++ b/generated/google/apis/file_v1/classes.rb @@ -455,7 +455,7 @@ module Google # @return [String] attr_accessor :create_time - # Optional. The description of the instance (2048 characters or less). + # The description of the instance (2048 characters or less). # Corresponds to the JSON property `description` # @return [String] attr_accessor :description diff --git a/generated/google/apis/file_v1/service.rb b/generated/google/apis/file_v1/service.rb index caa351dec..bb2577d02 100644 --- a/generated/google/apis/file_v1/service.rb +++ b/generated/google/apis/file_v1/service.rb @@ -122,12 +122,12 @@ module Google # Creates an instance. # @param [String] parent - # The instance's project and location, in the format + # Required. The instance's project and location, in the format # projects/`project_id`/locations/`location`. In Cloud Filestore, # locations map to GCP zones, for example **us-west1-b**. # @param [Google::Apis::FileV1::Instance] instance_object # @param [String] instance_id - # The name of the instance to create. + # Required. The name of the instance to create. # The name must be unique for the specified project and location. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -161,7 +161,7 @@ module Google # Deletes an instance. # @param [String] name - # The instance resource name, in the format + # Required. The instance resource name, in the format # projects/`project_id`/locations/`location`/instances/`instance_id` # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -192,7 +192,7 @@ module Google # Gets the details of a specific instance. # @param [String] name - # The instance resource name, in the format + # Required. The instance resource name, in the format # projects/`project_id`/locations/`location`/instances/`instance_id`. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -224,7 +224,7 @@ module Google # Lists all instances in a project for either a specified location # or for all locations. # @param [String] parent - # The project and location for which to retrieve instance information, + # Required. The project and location for which to retrieve instance information, # in the format projects/`project_id`/locations/`location`. In Cloud # Filestore, locations map to GCP zones, for example **us-west1-b**. To # retrieve instance information for all locations, use "-" for the `location` diff --git a/generated/google/apis/file_v1beta1.rb b/generated/google/apis/file_v1beta1.rb index 5a48eb0df..dd349afdc 100644 --- a/generated/google/apis/file_v1beta1.rb +++ b/generated/google/apis/file_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/filestore/ module FileV1beta1 VERSION = 'V1beta1' - REVISION = '20200320' + REVISION = '20200413' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/file_v1beta1/classes.rb b/generated/google/apis/file_v1beta1/classes.rb index efeaf7784..350695e6d 100644 --- a/generated/google/apis/file_v1beta1/classes.rb +++ b/generated/google/apis/file_v1beta1/classes.rb @@ -455,7 +455,7 @@ module Google # @return [String] attr_accessor :create_time - # Optional. The description of the instance (2048 characters or less). + # The description of the instance (2048 characters or less). # Corresponds to the JSON property `description` # @return [String] attr_accessor :description diff --git a/generated/google/apis/file_v1beta1/service.rb b/generated/google/apis/file_v1beta1/service.rb index ace4daa87..d30d8e2d0 100644 --- a/generated/google/apis/file_v1beta1/service.rb +++ b/generated/google/apis/file_v1beta1/service.rb @@ -122,13 +122,15 @@ module Google # Creates an instance. # @param [String] parent - # The instance's project and location, in the format + # Required. The instance's project and location, in the format # projects/`project_id`/locations/`location`. In Cloud Filestore, # locations map to GCP zones, for example **us-west1-b**. # @param [Google::Apis::FileV1beta1::Instance] instance_object # @param [String] instance_id - # The name of the instance to create. - # The name must be unique for the specified project and location. + # Required. The ID of the instance to create. + # The ID must be unique within the specified project and location. + # This value must start with a lowercase letter followed by up to 62 + # lowercase letters, numbers, or hyphens, and cannot end with a hyphen. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -161,7 +163,7 @@ module Google # Deletes an instance. # @param [String] name - # The instance resource name, in the format + # Required. The instance resource name, in the format # projects/`project_id`/locations/`location`/instances/`instance_id` # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -192,7 +194,7 @@ module Google # Gets the details of a specific instance. # @param [String] name - # The instance resource name, in the format + # Required. The instance resource name, in the format # projects/`project_id`/locations/`location`/instances/`instance_id`. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -224,7 +226,7 @@ module Google # Lists all instances in a project for either a specified location # or for all locations. # @param [String] parent - # The project and location for which to retrieve instance information, + # Required. The project and location for which to retrieve instance information, # in the format projects/`project_id`/locations/`location`. In Cloud # Filestore, locations map to GCP zones, for example **us-west1-b**. To # retrieve instance information for all locations, use "-" for the `location` @@ -275,7 +277,8 @@ module Google # projects/`project_id`/locations/`location_id`/instances/`instance_id`. # @param [Google::Apis::FileV1beta1::Instance] instance_object # @param [String] update_mask - # Mask of fields to update. At least one path must be supplied in this + # Required. Mask of fields to update. At least one path must be supplied in + # this # field. The elements of the repeated paths field may only include these # fields: # * "description" diff --git a/generated/google/apis/firebase_v1beta1.rb b/generated/google/apis/firebase_v1beta1.rb index 66c5e3649..2b3b5f908 100644 --- a/generated/google/apis/firebase_v1beta1.rb +++ b/generated/google/apis/firebase_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://firebase.google.com module FirebaseV1beta1 VERSION = 'V1beta1' - REVISION = '20200402' + REVISION = '20200506' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/firebase_v1beta1/service.rb b/generated/google/apis/firebase_v1beta1/service.rb index 1d91203d7..01a4e3ec6 100644 --- a/generated/google/apis/firebase_v1beta1/service.rb +++ b/generated/google/apis/firebase_v1beta1/service.rb @@ -156,8 +156,11 @@ module Google #
This method does not modify any billing account information on the # underlying GCP `Project`. #
- #
To call `AddFirebase`, a member must be an Editor or Owner for the - # existing GCP `Project`. Service accounts cannot call `AddFirebase`. + #
To call `AddFirebase`, a project member or service account must have + # the following permissions (the IAM roles of Editor and Owner contain these + # permissions): + # `firebase.projects.update`, `resourcemanager.projects.get`, + # `serviceusage.services.enable`, and `serviceusage.services.get`. # @param [String] project # The resource name of the GCP `Project` to which Firebase resources will be # added, in the format: diff --git a/generated/google/apis/firebasehosting_v1beta1.rb b/generated/google/apis/firebasehosting_v1beta1.rb index d71a2da3c..ed2a8c174 100644 --- a/generated/google/apis/firebasehosting_v1beta1.rb +++ b/generated/google/apis/firebasehosting_v1beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://firebase.google.com/docs/hosting/ module FirebasehostingV1beta1 VERSION = 'V1beta1' - REVISION = '20200407' + REVISION = '20200430' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/firebasehosting_v1beta1/classes.rb b/generated/google/apis/firebasehosting_v1beta1/classes.rb index 1eb886acf..d95a6dfe1 100644 --- a/generated/google/apis/firebasehosting_v1beta1/classes.rb +++ b/generated/google/apis/firebasehosting_v1beta1/classes.rb @@ -102,45 +102,6 @@ module Google end end - # The request sent to CloneVersion. - class CloneVersionRequest - include Google::Apis::Core::Hashable - - # A representation of filter path. - # Corresponds to the JSON property `exclude` - # @return [Google::Apis::FirebasehostingV1beta1::PathFilter] - attr_accessor :exclude - - # If true, immediately finalize the version after cloning is complete. - # Corresponds to the JSON property `finalize` - # @return [Boolean] - attr_accessor :finalize - alias_method :finalize?, :finalize - - # A representation of filter path. - # Corresponds to the JSON property `include` - # @return [Google::Apis::FirebasehostingV1beta1::PathFilter] - attr_accessor :include - - # Required. The name of the version to be cloned, in the format: - # `sites/`site`/versions/`version`` - # Corresponds to the JSON property `sourceVersion` - # @return [String] - attr_accessor :source_version - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @exclude = args[:exclude] if args.key?(:exclude) - @finalize = args[:finalize] if args.key?(:finalize) - @include = args[:include] if args.key?(:include) - @source_version = args[:source_version] if args.key?(:source_version) - end - end - # A configured rewrite that directs requests to a Cloud Run service. If the # Cloud Run service does not exist when setting or updating your Firebase # Hosting configuration, then the request fails. Any errors from the Cloud Run @@ -533,25 +494,6 @@ module Google end end - # A representation of filter path. - class PathFilter - include Google::Apis::Core::Hashable - - # An array of regexes to filter by. - # Corresponds to the JSON property `regexes` - # @return [Array] - attr_accessor :regexes - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @regexes = args[:regexes] if args.key?(:regexes) - end - end - # The request to populate a Version's Files. class PopulateVersionFilesRequest include Google::Apis::Core::Hashable @@ -864,6 +806,13 @@ module Google class SiteConfig include Google::Apis::Core::Hashable + # Whether or not web requests made by site visitors are logged via Cloud + # Logging. + # Corresponds to the JSON property `cloudLoggingEnabled` + # @return [Boolean] + attr_accessor :cloud_logging_enabled + alias_method :cloud_logging_enabled?, :cloud_logging_enabled + # The number of FINALIZED versions that will be held for a site before # automatic deletion. When a new version is deployed, content for versions # in storage in excess of this number will be deleted, and will no longer be @@ -879,6 +828,7 @@ module Google # Update properties of this object def update!(**args) + @cloud_logging_enabled = args[:cloud_logging_enabled] if args.key?(:cloud_logging_enabled) @max_versions = args[:max_versions] if args.key?(:max_versions) end end diff --git a/generated/google/apis/firebasehosting_v1beta1/representations.rb b/generated/google/apis/firebasehosting_v1beta1/representations.rb index 50fb9eb0d..325c6b59a 100644 --- a/generated/google/apis/firebasehosting_v1beta1/representations.rb +++ b/generated/google/apis/firebasehosting_v1beta1/representations.rb @@ -40,12 +40,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class CloneVersionRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class CloudRunRewrite class Representation < Google::Apis::Core::JsonRepresentation; end @@ -112,12 +106,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class PathFilter - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class PopulateVersionFilesRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -208,18 +196,6 @@ module Google end end - class CloneVersionRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :exclude, as: 'exclude', class: Google::Apis::FirebasehostingV1beta1::PathFilter, decorator: Google::Apis::FirebasehostingV1beta1::PathFilter::Representation - - property :finalize, as: 'finalize' - property :include, as: 'include', class: Google::Apis::FirebasehostingV1beta1::PathFilter, decorator: Google::Apis::FirebasehostingV1beta1::PathFilter::Representation - - property :source_version, as: 'sourceVersion' - end - end - class CloudRunRewrite # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -329,13 +305,6 @@ module Google end end - class PathFilter - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :regexes, as: 'regexes' - end - end - class PopulateVersionFilesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -414,6 +383,7 @@ module Google class SiteConfig # @private class Representation < Google::Apis::Core::JsonRepresentation + property :cloud_logging_enabled, as: 'cloudLoggingEnabled' property :max_versions, :numeric_string => true, as: 'maxVersions' end end diff --git a/generated/google/apis/firebasehosting_v1beta1/service.rb b/generated/google/apis/firebasehosting_v1beta1/service.rb index 892cd1243..7768332f6 100644 --- a/generated/google/apis/firebasehosting_v1beta1/service.rb +++ b/generated/google/apis/firebasehosting_v1beta1/service.rb @@ -481,41 +481,6 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new version on the target site using the content - # of the specified version. - # @param [String] parent - # Required. The target site where the cloned version will reside, - # in the format: `sites/`site`` - # @param [Google::Apis::FirebasehostingV1beta1::CloneVersionRequest] clone_version_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Operation] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::FirebasehostingV1beta1::Operation] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def clone_project_site_version(parent, clone_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta1/{+parent}/versions:clone', options) - command.request_representation = Google::Apis::FirebasehostingV1beta1::CloneVersionRequest::Representation - command.request_object = clone_version_request_object - command.response_representation = Google::Apis::FirebasehostingV1beta1::Operation::Representation - command.response_class = Google::Apis::FirebasehostingV1beta1::Operation - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - # Creates a new version for a site. # @param [String] parent # Required. The parent to create the version for, in the format: @@ -1159,41 +1124,6 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new version on the target site using the content - # of the specified version. - # @param [String] parent - # Required. The target site where the cloned version will reside, - # in the format: `sites/`site`` - # @param [Google::Apis::FirebasehostingV1beta1::CloneVersionRequest] clone_version_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Operation] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::FirebasehostingV1beta1::Operation] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def clone_site_version(parent, clone_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta1/{+parent}/versions:clone', options) - command.request_representation = Google::Apis::FirebasehostingV1beta1::CloneVersionRequest::Representation - command.request_object = clone_version_request_object - command.response_representation = Google::Apis::FirebasehostingV1beta1::Operation::Representation - command.response_class = Google::Apis::FirebasehostingV1beta1::Operation - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - # Creates a new version for a site. # @param [String] parent # Required. The parent to create the version for, in the format: diff --git a/generated/google/apis/firebaseml_v1beta2.rb b/generated/google/apis/firebaseml_v1beta2.rb new file mode 100644 index 000000000..8147ac40c --- /dev/null +++ b/generated/google/apis/firebaseml_v1beta2.rb @@ -0,0 +1,34 @@ +# 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 'google/apis/firebaseml_v1beta2/service.rb' +require 'google/apis/firebaseml_v1beta2/classes.rb' +require 'google/apis/firebaseml_v1beta2/representations.rb' + +module Google + module Apis + # Firebase ML API + # + # Access custom machine learning models hosted via Firebase ML. + # + # @see https://firebase.google.com + module FirebasemlV1beta2 + VERSION = 'V1beta2' + REVISION = '20200415' + + # View and manage your data across Google Cloud Platform services + AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' + end + end +end diff --git a/generated/google/apis/firebaseml_v1beta2/classes.rb b/generated/google/apis/firebaseml_v1beta2/classes.rb new file mode 100644 index 000000000..5e9f79b2c --- /dev/null +++ b/generated/google/apis/firebaseml_v1beta2/classes.rb @@ -0,0 +1,344 @@ +# 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 FirebasemlV1beta2 + + # A generic empty message that you can re-use to avoid defining duplicated + # empty messages in your APIs. A typical example is to use it as the request + # or the response type of an API method. For instance: + # service Foo ` + # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); + # ` + # The JSON representation for `Empty` is empty JSON object ````. + class Empty + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # The response for list models + class ListModelsResponse + include Google::Apis::Core::Hashable + + # The list of models + # Corresponds to the JSON property `models` + # @return [Array] + attr_accessor :models + + # Token to retrieve the next page of results, or empty if there are no + # more results in the list. + # 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) + @models = args[:models] if args.key?(:models) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # An ML model hosted in Firebase ML + class Model + include Google::Apis::Core::Hashable + + # Output only. Lists operation ids associated with this model whose status is + # NOT done. + # Corresponds to the JSON property `activeOperations` + # @return [Array] + attr_accessor :active_operations + + # Output only. Timestamp when this model was created in Firebase ML. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Required. The name of the model to create. The name can be up to 32 characters + # long + # and can consist only of ASCII Latin letters A-Z and a-z, underscores(_) + # and ASCII digits 0-9. It must start with a letter. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Output only. See RFC7232 + # https://tools.ietf.org/html/rfc7232#section-2.3 + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # Output only. The model_hash will change if a new file is available for + # download. + # Corresponds to the JSON property `modelHash` + # @return [String] + attr_accessor :model_hash + + # The resource name of the Model. + # Model names have the form `projects/`project_id`/models/`model_id`` + # The name is ignored when creating a model. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # State common to all model types. + # Includes publishing and validation information. + # Corresponds to the JSON property `state` + # @return [Google::Apis::FirebasemlV1beta2::ModelState] + attr_accessor :state + + # User defined tags which can be used to group/filter models during listing + # Corresponds to the JSON property `tags` + # @return [Array] + attr_accessor :tags + + # Information that is specific to TfLite models. + # Corresponds to the JSON property `tfliteModel` + # @return [Google::Apis::FirebasemlV1beta2::TfLiteModel] + attr_accessor :tflite_model + + # Output only. Timestamp when this model was updated in Firebase ML. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @active_operations = args[:active_operations] if args.key?(:active_operations) + @create_time = args[:create_time] if args.key?(:create_time) + @display_name = args[:display_name] if args.key?(:display_name) + @etag = args[:etag] if args.key?(:etag) + @model_hash = args[:model_hash] if args.key?(:model_hash) + @name = args[:name] if args.key?(:name) + @state = args[:state] if args.key?(:state) + @tags = args[:tags] if args.key?(:tags) + @tflite_model = args[:tflite_model] if args.key?(:tflite_model) + @update_time = args[:update_time] if args.key?(:update_time) + end + end + + # This is returned in the longrunning operations + # for create/update. + class ModelOperationMetadata + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `basicOperationStatus` + # @return [String] + attr_accessor :basic_operation_status + + # The name of the model we are creating/updating + # The name must have the form `projects/`project_id`/models/`model_id`` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @basic_operation_status = args[:basic_operation_status] if args.key?(:basic_operation_status) + @name = args[:name] if args.key?(:name) + end + end + + # State common to all model types. + # Includes publishing and validation information. + class ModelState + include Google::Apis::Core::Hashable + + # Indicates if this model has been published. + # Corresponds to the JSON property `published` + # @return [Boolean] + attr_accessor :published + alias_method :published?, :published + + # 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). Each `Status` message contains + # three pieces of data: error code, error message, and error details. + # You can find out more about this error model and how to work with it in the + # [API Design Guide](https://cloud.google.com/apis/design/errors). + # Corresponds to the JSON property `validationError` + # @return [Google::Apis::FirebasemlV1beta2::Status] + attr_accessor :validation_error + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @published = args[:published] if args.key?(:published) + @validation_error = args[:validation_error] if args.key?(:validation_error) + end + end + + # This resource represents a long-running operation that is the result of a + # network API call. + class Operation + include Google::Apis::Core::Hashable + + # If the value is `false`, it means the operation is still in progress. + # If `true`, the operation is completed, and either `error` or `response` is + # available. + # Corresponds to the JSON property `done` + # @return [Boolean] + attr_accessor :done + alias_method :done?, :done + + # 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). Each `Status` message contains + # three pieces of data: error code, error message, and error details. + # You can find out more about this error model and how to work with it in the + # [API Design Guide](https://cloud.google.com/apis/design/errors). + # Corresponds to the JSON property `error` + # @return [Google::Apis::FirebasemlV1beta2::Status] + attr_accessor :error + + # Service-specific metadata associated with the operation. It typically + # contains progress information and common metadata such as create time. + # Some services might not provide such metadata. Any method that returns a + # long-running operation should document the metadata type, if any. + # Corresponds to the JSON property `metadata` + # @return [Hash] + attr_accessor :metadata + + # The server-assigned name, which is only unique within the same service that + # originally returns it. If you use the default HTTP mapping, the + # `name` should be a resource name ending with `operations/`unique_id``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The normal response of the operation in case of success. If the original + # method returns no data on success, such as `Delete`, the response is + # `google.protobuf.Empty`. If the original method is standard + # `Get`/`Create`/`Update`, the response should be the resource. For other + # methods, the response should have the type `XxxResponse`, where `Xxx` + # is the original method name. For example, if the original method name + # is `TakeSnapshot()`, the inferred response type is + # `TakeSnapshotResponse`. + # Corresponds to the JSON property `response` + # @return [Hash] + attr_accessor :response + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @done = args[:done] if args.key?(:done) + @error = args[:error] if args.key?(:error) + @metadata = args[:metadata] if args.key?(:metadata) + @name = args[:name] if args.key?(:name) + @response = args[:response] if args.key?(:response) + end + end + + # 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). Each `Status` message contains + # three pieces of data: error code, error message, and error details. + # You can find out more about this error model and how to work with it in the + # [API Design Guide](https://cloud.google.com/apis/design/errors). + class Status + include Google::Apis::Core::Hashable + + # The status code, which should be an enum value of google.rpc.Code. + # Corresponds to the JSON property `code` + # @return [Fixnum] + attr_accessor :code + + # A list of messages that carry the error details. There is a common set of + # message types for APIs to use. + # Corresponds to the JSON property `details` + # @return [Array>] + attr_accessor :details + + # 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` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @details = args[:details] if args.key?(:details) + @message = args[:message] if args.key?(:message) + end + end + + # Information that is specific to TfLite models. + class TfLiteModel + include Google::Apis::Core::Hashable + + # The TfLite file containing the model. (Stored in Google Cloud). + # The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite + # Note: If you update the file in the original location, it is + # necessary to call UpdateModel for ML to pick up and validate the + # updated file. + # Corresponds to the JSON property `gcsTfliteUri` + # @return [String] + attr_accessor :gcs_tflite_uri + + # Output only. The size of the TFLite model + # Corresponds to the JSON property `sizeBytes` + # @return [String] + attr_accessor :size_bytes + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @gcs_tflite_uri = args[:gcs_tflite_uri] if args.key?(:gcs_tflite_uri) + @size_bytes = args[:size_bytes] if args.key?(:size_bytes) + end + end + end + end +end diff --git a/generated/google/apis/firebaseml_v1beta2/representations.rb b/generated/google/apis/firebaseml_v1beta2/representations.rb new file mode 100644 index 000000000..12450f4dd --- /dev/null +++ b/generated/google/apis/firebaseml_v1beta2/representations.rb @@ -0,0 +1,154 @@ +# 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 FirebasemlV1beta2 + + class Empty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListModelsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Model + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ModelOperationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ModelState + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Operation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Status + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TfLiteModel + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Empty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class ListModelsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :models, as: 'models', class: Google::Apis::FirebasemlV1beta2::Model, decorator: Google::Apis::FirebasemlV1beta2::Model::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class Model + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :active_operations, as: 'activeOperations', class: Google::Apis::FirebasemlV1beta2::Operation, decorator: Google::Apis::FirebasemlV1beta2::Operation::Representation + + property :create_time, as: 'createTime' + property :display_name, as: 'displayName' + property :etag, as: 'etag' + property :model_hash, as: 'modelHash' + property :name, as: 'name' + property :state, as: 'state', class: Google::Apis::FirebasemlV1beta2::ModelState, decorator: Google::Apis::FirebasemlV1beta2::ModelState::Representation + + collection :tags, as: 'tags' + property :tflite_model, as: 'tfliteModel', class: Google::Apis::FirebasemlV1beta2::TfLiteModel, decorator: Google::Apis::FirebasemlV1beta2::TfLiteModel::Representation + + property :update_time, as: 'updateTime' + end + end + + class ModelOperationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :basic_operation_status, as: 'basicOperationStatus' + property :name, as: 'name' + end + end + + class ModelState + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :published, as: 'published' + property :validation_error, as: 'validationError', class: Google::Apis::FirebasemlV1beta2::Status, decorator: Google::Apis::FirebasemlV1beta2::Status::Representation + + end + end + + class Operation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :done, as: 'done' + property :error, as: 'error', class: Google::Apis::FirebasemlV1beta2::Status, decorator: Google::Apis::FirebasemlV1beta2::Status::Representation + + hash :metadata, as: 'metadata' + property :name, as: 'name' + hash :response, as: 'response' + end + end + + class Status + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :details, as: 'details' + property :message, as: 'message' + end + end + + class TfLiteModel + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :gcs_tflite_uri, as: 'gcsTfliteUri' + property :size_bytes, as: 'sizeBytes' + end + end + end + end +end diff --git a/generated/google/apis/firebaseml_v1beta2/service.rb b/generated/google/apis/firebaseml_v1beta2/service.rb new file mode 100644 index 000000000..91cbd8f3b --- /dev/null +++ b/generated/google/apis/firebaseml_v1beta2/service.rb @@ -0,0 +1,267 @@ +# 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 '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 FirebasemlV1beta2 + # Firebase ML API + # + # Access custom machine learning models hosted via Firebase ML. + # + # @example + # require 'google/apis/firebaseml_v1beta2' + # + # Firebaseml = Google::Apis::FirebasemlV1beta2 # Alias the module + # service = Firebaseml::FirebaseMLService.new + # + # @see https://firebase.google.com + class FirebaseMLService < Google::Apis::Core::BaseService + # @return [String] + # API key. Your API key identifies your project and provides you with API access, + # quota, and reports. Required unless you provide an OAuth 2.0 token. + attr_accessor :key + + # @return [String] + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + attr_accessor :quota_user + + def initialize + super('https://firebaseml.googleapis.com/', '') + @batch_path = 'batch' + end + + # Creates a model in Firebase ML. + # The longrunning operation will eventually return a Model + # @param [String] parent + # Required. The parent project resource where the model is to be created. + # The parent must have the form `projects/`project_id`` + # @param [Google::Apis::FirebasemlV1beta2::Model] model_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasemlV1beta2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasemlV1beta2::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_model(parent, model_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta2/{+parent}/models', options) + command.request_representation = Google::Apis::FirebasemlV1beta2::Model::Representation + command.request_object = model_object + command.response_representation = Google::Apis::FirebasemlV1beta2::Operation::Representation + command.response_class = Google::Apis::FirebasemlV1beta2::Operation + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a model + # @param [String] name + # Required. The name of the model to delete. + # The name must have the form `projects/`project_id`/models/`model_id`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasemlV1beta2::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasemlV1beta2::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_model(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta2/{+name}', options) + command.response_representation = Google::Apis::FirebasemlV1beta2::Empty::Representation + command.response_class = Google::Apis::FirebasemlV1beta2::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a model resource. + # @param [String] name + # Required. The name of the model to get. + # The name must have the form `projects/`project_id`/models/`model_id`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasemlV1beta2::Model] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasemlV1beta2::Model] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_model(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta2/{+name}', options) + command.response_representation = Google::Apis::FirebasemlV1beta2::Model::Representation + command.response_class = Google::Apis::FirebasemlV1beta2::Model + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the models + # @param [String] parent + # Required. The name of the parent to list models for. + # The parent must have the form `projects/`project_id`' + # @param [String] filter + # A filter for the list + # e.g. 'tags: abc' to list models which are tagged with "abc" + # @param [Fixnum] page_size + # The maximum number of items to return + # @param [String] page_token + # The next_page_token value returned from a previous List request, if any. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasemlV1beta2::ListModelsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasemlV1beta2::ListModelsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_models(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta2/{+parent}/models', options) + command.response_representation = Google::Apis::FirebasemlV1beta2::ListModelsResponse::Representation + command.response_class = Google::Apis::FirebasemlV1beta2::ListModelsResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates a model. The longrunning operation will eventually return a Model. + # @param [String] name + # The resource name of the Model. + # Model names have the form `projects/`project_id`/models/`model_id`` + # The name is ignored when creating a model. + # @param [Google::Apis::FirebasemlV1beta2::Model] model_object + # @param [String] update_mask + # The update mask + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasemlV1beta2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasemlV1beta2::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_model(name, model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1beta2/{+name}', options) + command.request_representation = Google::Apis::FirebasemlV1beta2::Model::Representation + command.request_object = model_object + command.response_representation = Google::Apis::FirebasemlV1beta2::Operation::Representation + command.response_class = Google::Apis::FirebasemlV1beta2::Operation + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the latest state of a long-running operation. Clients can use this + # method to poll the operation result at intervals as recommended by the API + # service. + # @param [String] name + # The name of the operation resource. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasemlV1beta2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasemlV1beta2::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta2/{+name}', options) + command.response_representation = Google::Apis::FirebasemlV1beta2::Operation::Representation + command.response_class = Google::Apis::FirebasemlV1beta2::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/games_configuration_v1configuration.rb b/generated/google/apis/games_configuration_v1configuration.rb index f822df4d8..df2179e71 100644 --- a/generated/google/apis/games_configuration_v1configuration.rb +++ b/generated/google/apis/games_configuration_v1configuration.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/games/ module GamesConfigurationV1configuration VERSION = 'V1configuration' - REVISION = '20200317' + REVISION = '20200416' # View and manage your Google Play Developer account AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher' diff --git a/generated/google/apis/games_configuration_v1configuration/classes.rb b/generated/google/apis/games_configuration_v1configuration/classes.rb index d06bdd3dc..2388da054 100644 --- a/generated/google/apis/games_configuration_v1configuration/classes.rb +++ b/generated/google/apis/games_configuration_v1configuration/classes.rb @@ -47,7 +47,7 @@ module Google attr_accessor :initial_state # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesConfiguration#achievementConfiguration. + # string `gamesConfiguration#achievementConfiguration`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -99,7 +99,7 @@ module Google attr_accessor :icon_url # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesConfiguration#achievementConfigurationDetail. + # string `gamesConfiguration#achievementConfigurationDetail`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -144,8 +144,7 @@ module Google attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed - # string - # gamesConfiguration#achievementConfigurationListResponse. + # string `gamesConfiguration#achievementConfigurationListResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -263,7 +262,7 @@ module Google attr_accessor :image_type # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesConfiguration#imageConfiguration. + # string `gamesConfiguration#imageConfiguration`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -306,7 +305,7 @@ module Google attr_accessor :id # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesConfiguration#leaderboardConfiguration. + # string `gamesConfiguration#leaderboardConfiguration`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -363,7 +362,7 @@ module Google attr_accessor :icon_url # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesConfiguration#leaderboardConfigurationDetail. + # string `gamesConfiguration#leaderboardConfigurationDetail`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -408,7 +407,7 @@ module Google # Uniquely identifies the type of this resource. Value is always the fixed # string - # gamesConfiguration#leaderboardConfigurationListResponse. + # `gamesConfiguration#leaderboardConfigurationListResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -435,7 +434,7 @@ module Google include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesConfiguration#localizedString. + # string `gamesConfiguration#localizedString`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -467,7 +466,7 @@ module Google include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesConfiguration#localizedStringBundle. + # string `gamesConfiguration#localizedStringBundle`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind diff --git a/generated/google/apis/games_configuration_v1configuration/service.rb b/generated/google/apis/games_configuration_v1configuration/service.rb index 2afb4d266..669d7002c 100644 --- a/generated/google/apis/games_configuration_v1configuration/service.rb +++ b/generated/google/apis/games_configuration_v1configuration/service.rb @@ -145,7 +145,7 @@ module Google # @param [Fixnum] max_results # The maximum number of resource configurations to return in the response, # used for paging. For any response, the actual number of resources returned - # may be less than the specified maxResults. + # may be less than the specified `maxResults`. # @param [String] page_token # The token returned by the previous request. # @param [String] fields @@ -350,7 +350,7 @@ module Google # @param [Fixnum] max_results # The maximum number of resource configurations to return in the response, # used for paging. For any response, the actual number of resources returned - # may be less than the specified maxResults. + # may be less than the specified `maxResults`. # @param [String] page_token # The token returned by the previous request. # @param [String] fields diff --git a/generated/google/apis/games_management_v1management.rb b/generated/google/apis/games_management_v1management.rb index 8604dd2b0..6ca6840e5 100644 --- a/generated/google/apis/games_management_v1management.rb +++ b/generated/google/apis/games_management_v1management.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/games/services module GamesManagementV1management VERSION = 'V1management' - REVISION = '20200306' + REVISION = '20200416' # Create, edit, and delete your Google Play Games activity AUTH_GAMES = 'https://www.googleapis.com/auth/games' diff --git a/generated/google/apis/games_management_v1management/classes.rb b/generated/google/apis/games_management_v1management/classes.rb index 156af5f88..5d8a9ccdb 100644 --- a/generated/google/apis/games_management_v1management/classes.rb +++ b/generated/google/apis/games_management_v1management/classes.rb @@ -370,11 +370,6 @@ module Google # @return [String] attr_accessor :player_id - # - # Corresponds to the JSON property `playerStattus` - # @return [String] - attr_accessor :player_stattus - # This is a JSON template for profile settings # Corresponds to the JSON property `profileSettings` # @return [Google::Apis::GamesManagementV1management::ProfileSettings] @@ -402,7 +397,6 @@ module Google @name = args[:name] if args.key?(:name) @original_player_id = args[:original_player_id] if args.key?(:original_player_id) @player_id = args[:player_id] if args.key?(:player_id) - @player_stattus = args[:player_stattus] if args.key?(:player_stattus) @profile_settings = args[:profile_settings] if args.key?(:profile_settings) @title = args[:title] if args.key?(:title) end diff --git a/generated/google/apis/games_management_v1management/representations.rb b/generated/google/apis/games_management_v1management/representations.rb index 2ac8f1cab..14a373821 100644 --- a/generated/google/apis/games_management_v1management/representations.rb +++ b/generated/google/apis/games_management_v1management/representations.rb @@ -213,7 +213,6 @@ module Google property :original_player_id, as: 'originalPlayerId' property :player_id, as: 'playerId' - property :player_stattus, as: 'playerStattus' property :profile_settings, as: 'profileSettings', class: Google::Apis::GamesManagementV1management::ProfileSettings, decorator: Google::Apis::GamesManagementV1management::ProfileSettings::Representation property :title, as: 'title' diff --git a/generated/google/apis/games_v1.rb b/generated/google/apis/games_v1.rb index b5a79a8bf..49423cc5d 100644 --- a/generated/google/apis/games_v1.rb +++ b/generated/google/apis/games_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/games/services/ module GamesV1 VERSION = 'V1' - REVISION = '20200330' + REVISION = '20200416' # View and manage its own configuration data in your Google Drive AUTH_DRIVE_APPDATA = 'https://www.googleapis.com/auth/drive.appdata' diff --git a/generated/google/apis/games_v1/classes.rb b/generated/google/apis/games_v1/classes.rb index 0724de6e9..19c010b6d 100644 --- a/generated/google/apis/games_v1/classes.rb +++ b/generated/google/apis/games_v1/classes.rb @@ -314,7 +314,7 @@ module Google include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed - # string games#achievementUpdateListResponse. + # string games#achievementUpdateMultipleResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2044,11 +2044,6 @@ module Google # @return [String] attr_accessor :player_id - # - # Corresponds to the JSON property `playerStattus` - # @return [String] - attr_accessor :player_stattus - # This is a JSON template for profile settings # Corresponds to the JSON property `profileSettings` # @return [Google::Apis::GamesV1::ProfileSettings] @@ -2076,7 +2071,6 @@ module Google @name = args[:name] if args.key?(:name) @original_player_id = args[:original_player_id] if args.key?(:original_player_id) @player_id = args[:player_id] if args.key?(:player_id) - @player_stattus = args[:player_stattus] if args.key?(:player_stattus) @profile_settings = args[:profile_settings] if args.key?(:profile_settings) @title = args[:title] if args.key?(:title) end diff --git a/generated/google/apis/games_v1/representations.rb b/generated/google/apis/games_v1/representations.rb index b00f91086..8c47c37d8 100644 --- a/generated/google/apis/games_v1/representations.rb +++ b/generated/google/apis/games_v1/representations.rb @@ -1112,7 +1112,6 @@ module Google property :original_player_id, as: 'originalPlayerId' property :player_id, as: 'playerId' - property :player_stattus, as: 'playerStattus' property :profile_settings, as: 'profileSettings', class: Google::Apis::GamesV1::ProfileSettings, decorator: Google::Apis::GamesV1::ProfileSettings::Representation property :title, as: 'title' diff --git a/generated/google/apis/games_v1/service.rb b/generated/google/apis/games_v1/service.rb index 6ab81fd9e..5835fbace 100644 --- a/generated/google/apis/games_v1/service.rb +++ b/generated/google/apis/games_v1/service.rb @@ -260,8 +260,6 @@ module Google # Unlocks this achievement for the currently authenticated player. # @param [String] achievement_id # The ID of the achievement used by this method. - # @param [String] builtin_game_id - # Override used only by built-in games in Play Games application. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -281,12 +279,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def unlock_achievement(achievement_id, builtin_game_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def unlock_achievement(achievement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'achievements/{achievementId}/unlock', options) command.response_representation = Google::Apis::GamesV1::AchievementUnlockResponse::Representation command.response_class = Google::Apis::GamesV1::AchievementUnlockResponse command.params['achievementId'] = achievement_id unless achievement_id.nil? - command.query['builtinGameId'] = builtin_game_id unless builtin_game_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -295,8 +292,6 @@ module Google # Updates multiple achievements for the currently authenticated player. # @param [Google::Apis::GamesV1::AchievementUpdateMultipleRequest] achievement_update_multiple_request_object - # @param [String] builtin_game_id - # Override used only by built-in games in Play Games application. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -316,13 +311,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_multiple_achievements(achievement_update_multiple_request_object = nil, builtin_game_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def update_multiple_achievements(achievement_update_multiple_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'achievements/updateMultiple', options) command.request_representation = Google::Apis::GamesV1::AchievementUpdateMultipleRequest::Representation command.request_object = achievement_update_multiple_request_object command.response_representation = Google::Apis::GamesV1::AchievementUpdateMultipleResponse::Representation command.response_class = Google::Apis::GamesV1::AchievementUpdateMultipleResponse - command.query['builtinGameId'] = builtin_game_id unless builtin_game_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -371,8 +365,6 @@ module Google end # Indicate that the the currently authenticated user is playing your application. - # @param [String] builtin_game_id - # Override used only by built-in games in Play Games application. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -392,9 +384,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def played_application(builtin_game_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def played_application(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'applications/played', options) - command.query['builtinGameId'] = builtin_game_id unless builtin_game_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? diff --git a/generated/google/apis/gameservices_v1beta.rb b/generated/google/apis/gameservices_v1beta.rb index f51ef7713..b495e6fb0 100644 --- a/generated/google/apis/gameservices_v1beta.rb +++ b/generated/google/apis/gameservices_v1beta.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/solutions/gaming/ module GameservicesV1beta VERSION = 'V1beta' - REVISION = '20200402' + REVISION = '20200423' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/gameservices_v1beta/classes.rb b/generated/google/apis/gameservices_v1beta/classes.rb index d30e63a0f..1f8d4d274 100644 --- a/generated/google/apis/gameservices_v1beta/classes.rb +++ b/generated/google/apis/gameservices_v1beta/classes.rb @@ -2083,8 +2083,7 @@ module Google # 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" - # This field is only used by Cloud IAM. + # `paths: "bindings, etag"` # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask diff --git a/generated/google/apis/gameservices_v1beta/service.rb b/generated/google/apis/gameservices_v1beta/service.rb index 2693b53d9..5befc0ef4 100644 --- a/generated/google/apis/gameservices_v1beta/service.rb +++ b/generated/google/apis/gameservices_v1beta/service.rb @@ -473,7 +473,7 @@ module Google # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. @@ -509,7 +509,7 @@ module Google # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. diff --git a/generated/google/apis/healthcare_v1.rb b/generated/google/apis/healthcare_v1.rb index 50468d45e..ffc1fdd1d 100644 --- a/generated/google/apis/healthcare_v1.rb +++ b/generated/google/apis/healthcare_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/healthcare module HealthcareV1 VERSION = 'V1' - REVISION = '20200327' + REVISION = '20200414' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/healthcare_v1/classes.rb b/generated/google/apis/healthcare_v1/classes.rb index 410e25e8f..a92ee6a49 100644 --- a/generated/google/apis/healthcare_v1/classes.rb +++ b/generated/google/apis/healthcare_v1/classes.rb @@ -937,7 +937,6 @@ module Google # The FHIR specification version that this FHIR store supports natively. This # field is immutable after store creation. Requests are rejected if they # contain FHIR resources of a different version. - # An empty value is treated as STU3. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version diff --git a/generated/google/apis/healthcare_v1/service.rb b/generated/google/apis/healthcare_v1/service.rb index c9e53034b..933e4f3f5 100644 --- a/generated/google/apis/healthcare_v1/service.rb +++ b/generated/google/apis/healthcare_v1/service.rb @@ -2154,6 +2154,15 @@ module Google execute_or_queue_command(command, &block) end + # Retrieves all the resources directly referenced by a patient, as well as + # all of the resources in the patient compartment. + # Implements the FHIR extended operation Patient-everything + # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html# + # everything), + # [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html# + # everything), + # [R4](http://hl7.org/implement/standards/fhir/R4/patient-operations.html# + # everything)). # On success, the response body will contain a JSON-encoded representation # of a `Bundle` resource of type `searchset`, containing the results of the # operation. @@ -2293,13 +2302,6 @@ module Google # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#create), # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#create)), # which creates a new resource with a server-assigned resource ID. - # Also supports the FHIR standard conditional create interaction - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#ccreate), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#ccreate), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#ccreate)), - # specified by supplying an `If-None-Exist` header containing a FHIR search - # query. If no resources match this search query, the server processes the - # create operation as normal. # The request body must contain a JSON-encoded FHIR resource, and the request # headers must contain `Content-Type: application/fhir+json`. # On success, the response body will contain a JSON-encoded representation diff --git a/generated/google/apis/healthcare_v1beta1.rb b/generated/google/apis/healthcare_v1beta1.rb index 6999eaa8b..2bc5b889c 100644 --- a/generated/google/apis/healthcare_v1beta1.rb +++ b/generated/google/apis/healthcare_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/healthcare module HealthcareV1beta1 VERSION = 'V1beta1' - REVISION = '20200327' + REVISION = '20200414' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/healthcare_v1beta1/service.rb b/generated/google/apis/healthcare_v1beta1/service.rb index 08a189713..f10ac4da8 100644 --- a/generated/google/apis/healthcare_v1beta1/service.rb +++ b/generated/google/apis/healthcare_v1beta1/service.rb @@ -2022,7 +2022,7 @@ module Google # if the input data contains invalid references or if some resources fail to # be imported, the FHIR store might be left in a state that violates # referential integrity. - # The import process does not trigger PubSub notification or BigQuery + # The import process does not trigger Cloud Pub/Sub notification or BigQuery # streaming update, regardless of how those are configured on the FHIR store. # If a resource with the specified ID already exists, the most recent # version of the resource is overwritten without creating a new historical @@ -2345,6 +2345,120 @@ module Google execute_or_queue_command(command, &block) end + # Translates a code from one value set to another by searching for + # appropriate concept maps. + # Implements the FHIR standard $translate operation + # ([DSTU2](https://www.hl7.org/fhir/DSTU2/operation-conceptmap-translate.html), + # [STU3](https://www.hl7.org/fhir/STU3/operation-conceptmap-translate.html), + # [R4](https://www.hl7.org/fhir/R4/operation-conceptmap-translate.html)). + # On success, the response body contains a JSON-encoded representation + # of a FHIR Parameters resource, which includes the translation result. + # Errors generated by the FHIR store contain a JSON-encoded + # `OperationOutcome` resource describing the reason for the error. If the + # request cannot be mapped to a valid API method on a FHIR store, a generic + # GCP error might be returned instead. + # @param [String] parent + # The name for the FHIR store containing the concept map(s) to use for the + # translation. + # @param [String] code + # The code to translate. + # @param [String] concept_map_version + # The version of the concept map to use. If unset, the most current version + # is used. + # @param [String] source + # The source value set of the concept map to be used. If unset, target is + # used to search for concept maps. + # @param [String] system + # The system for the code to be translated. + # @param [String] target + # The target value set of the concept map to be used. If unset, source is + # used to search for concept maps. + # @param [String] url + # The canonical url of the concept map to use. If unset, the source and + # target is used to search for concept maps. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1beta1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1beta1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def concept_project_location_dataset_fhir_store_fhir_map_search_translate(parent, code: nil, concept_map_version: nil, source: nil, system: nil, target: nil, url: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+parent}/fhir/ConceptMap/$translate', options) + command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1beta1::HttpBody + command.params['parent'] = parent unless parent.nil? + command.query['code'] = code unless code.nil? + command.query['conceptMapVersion'] = concept_map_version unless concept_map_version.nil? + command.query['source'] = source unless source.nil? + command.query['system'] = system unless system.nil? + command.query['target'] = target unless target.nil? + command.query['url'] = url unless url.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Translates a code from one value set to another using a concept map. + # Implements the FHIR standard $translate operation + # ([DSTU2](https://www.hl7.org/fhir/DSTU2/operation-conceptmap-translate.html), + # [STU3](https://www.hl7.org/fhir/STU3/operation-conceptmap-translate.html), + # [R4](https://www.hl7.org/fhir/R4/operation-conceptmap-translate.html)). + # On success, the response body contains a JSON-encoded representation + # of a FHIR Parameters resource, which includes the translation result. + # Errors generated by the FHIR store contain a JSON-encoded + # `OperationOutcome` resource describing the reason for the error. If the + # request cannot be mapped to a valid API method on a FHIR store, a generic + # GCP error might be returned instead. + # @param [String] name + # The URL for the concept map to use for the translation. + # @param [String] code + # The code to translate. + # @param [String] concept_map_version + # The version of the concept map to use. If unset, the most current version + # is used. + # @param [String] system + # The system for the code to be translated. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1beta1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1beta1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def concept_project_location_dataset_fhir_store_fhir_map_translate(name, code: nil, concept_map_version: nil, system: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+name}/$translate', options) + command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1beta1::HttpBody + command.params['name'] = name unless name.nil? + command.query['code'] = code unless code.nil? + command.query['conceptMapVersion'] = concept_map_version unless concept_map_version.nil? + command.query['system'] = system unless system.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Retrieves the N most recent `Observation` resources for a subject matching # search criteria specified as query parameters, grouped by # `Observation.code`, sorted from most recent to oldest. @@ -2405,6 +2519,15 @@ module Google execute_or_queue_command(command, &block) end + # Retrieves all the resources directly referenced by a patient, as well as + # all of the resources in the patient compartment. + # Implements the FHIR extended operation Patient-everything + # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html# + # everything), + # [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html# + # everything), + # [R4](http://hl7.org/implement/standards/fhir/R4/patient-operations.html# + # everything)). # On success, the response body will contain a JSON-encoded representation # of a `Bundle` resource of type `searchset`, containing the results of the # operation. diff --git a/generated/google/apis/homegraph_v1.rb b/generated/google/apis/homegraph_v1.rb index fb1501ec7..26d68233c 100644 --- a/generated/google/apis/homegraph_v1.rb +++ b/generated/google/apis/homegraph_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/actions/smarthome/create-app#request-sync module HomegraphV1 VERSION = 'V1' - REVISION = '20200407' + REVISION = '20200415' end end end diff --git a/generated/google/apis/homegraph_v1/classes.rb b/generated/google/apis/homegraph_v1/classes.rb index 83aef3f57..8f082e32b 100644 --- a/generated/google/apis/homegraph_v1/classes.rb +++ b/generated/google/apis/homegraph_v1/classes.rb @@ -103,18 +103,19 @@ module Google attr_accessor :name # Indicates whether your smart home Action will report notifications - # to Google for this device via ReportStateAndNotification. + # to Google for this device via + # ReportStateAndNotification. # If your smart home Action enables users to control device notifications, - # you should update this field and call RequestSyncDevices. + # you should update this field and call + # RequestSyncDevices. # Corresponds to the JSON property `notificationSupportedByAgent` # @return [Boolean] attr_accessor :notification_supported_by_agent alias_method :notification_supported_by_agent?, :notification_supported_by_agent # Alternate IDs associated with this device. - # This is used to identify cloud synced devices enabled for - # [local - # execution](https://developers.google.com/assistant/smarthome/concepts/local). + # This is used to identify cloud synced devices enabled for [local + # fulfillment](https://developers.google.com/assistant/smarthome/concepts/local). # Corresponds to the JSON property `otherDeviceIds` # @return [Array] attr_accessor :other_device_ids @@ -146,7 +147,8 @@ module Google attr_accessor :type # Indicates whether your smart home Action will report state of this device - # to Google via ReportStateAndNotification. + # to Google via + # ReportStateAndNotification. # Corresponds to the JSON property `willReportState` # @return [Boolean] attr_accessor :will_report_state diff --git a/generated/google/apis/iamcredentials_v1.rb b/generated/google/apis/iamcredentials_v1.rb index 71333e326..ac938cd32 100644 --- a/generated/google/apis/iamcredentials_v1.rb +++ b/generated/google/apis/iamcredentials_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials module IamcredentialsV1 VERSION = 'V1' - REVISION = '20200227' + REVISION = '20200417' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/iamcredentials_v1/classes.rb b/generated/google/apis/iamcredentials_v1/classes.rb index 9d0aeb85c..e9dc6e3fa 100644 --- a/generated/google/apis/iamcredentials_v1/classes.rb +++ b/generated/google/apis/iamcredentials_v1/classes.rb @@ -199,7 +199,7 @@ module Google # @return [String] attr_accessor :key_id - # The signed blob. + # The signature for the blob. Does not include the original blob. # Corresponds to the JSON property `signedBlob` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -233,8 +233,11 @@ module Google # @return [Array] attr_accessor :delegates - # Required. The JWT payload to sign: a JSON object that contains a JWT Claims - # Set. + # Required. The JWT payload to sign. Must be a serialized JSON object that + # contains a + # JWT Claim Set. For example: ``"sub": "user@example.com", "iat": 313435`` + # If the claim set contains an `exp` claim, it must be an integer timestamp + # that is not in the past and at most 12 hours in the future. # Corresponds to the JSON property `payload` # @return [String] attr_accessor :payload @@ -259,7 +262,9 @@ module Google # @return [String] attr_accessor :key_id - # The signed JWT. + # The signed JWT. Contains the automatically generated header; the + # client-supplied payload; and the signature, which is generated using the + # key referenced by the `kid` field in the header. # Corresponds to the JSON property `signedJwt` # @return [String] attr_accessor :signed_jwt diff --git a/generated/google/apis/managedidentities_v1.rb b/generated/google/apis/managedidentities_v1.rb index e7c0fe915..7b4f70935 100644 --- a/generated/google/apis/managedidentities_v1.rb +++ b/generated/google/apis/managedidentities_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/managed-microsoft-ad/ module ManagedidentitiesV1 VERSION = 'V1' - REVISION = '20200326' + REVISION = '20200415' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/managedidentities_v1/service.rb b/generated/google/apis/managedidentities_v1/service.rb index e7c000d2a..61cd3bf6c 100644 --- a/generated/google/apis/managedidentities_v1/service.rb +++ b/generated/google/apis/managedidentities_v1/service.rb @@ -505,7 +505,7 @@ module Google # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. @@ -541,7 +541,7 @@ module Google # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. diff --git a/generated/google/apis/managedidentities_v1alpha1.rb b/generated/google/apis/managedidentities_v1alpha1.rb index b6386e86c..2ede2c511 100644 --- a/generated/google/apis/managedidentities_v1alpha1.rb +++ b/generated/google/apis/managedidentities_v1alpha1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/managed-microsoft-ad/ module ManagedidentitiesV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200326' + REVISION = '20200415' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/managedidentities_v1alpha1/service.rb b/generated/google/apis/managedidentities_v1alpha1/service.rb index 2627a2e87..6695d29be 100644 --- a/generated/google/apis/managedidentities_v1alpha1/service.rb +++ b/generated/google/apis/managedidentities_v1alpha1/service.rb @@ -508,7 +508,7 @@ module Google # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. @@ -544,7 +544,7 @@ module Google # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. diff --git a/generated/google/apis/managedidentities_v1beta1.rb b/generated/google/apis/managedidentities_v1beta1.rb index 2d0b97b0a..00bf0bb7f 100644 --- a/generated/google/apis/managedidentities_v1beta1.rb +++ b/generated/google/apis/managedidentities_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/managed-microsoft-ad/ module ManagedidentitiesV1beta1 VERSION = 'V1beta1' - REVISION = '20200326' + REVISION = '20200415' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/managedidentities_v1beta1/service.rb b/generated/google/apis/managedidentities_v1beta1/service.rb index 1582dfa6f..a20856b43 100644 --- a/generated/google/apis/managedidentities_v1beta1/service.rb +++ b/generated/google/apis/managedidentities_v1beta1/service.rb @@ -504,7 +504,7 @@ module Google # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. @@ -540,7 +540,7 @@ module Google # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. diff --git a/generated/google/apis/memcache_v1beta2.rb b/generated/google/apis/memcache_v1beta2.rb index db06f642b..376c00143 100644 --- a/generated/google/apis/memcache_v1beta2.rb +++ b/generated/google/apis/memcache_v1beta2.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/memorystore/ module MemcacheV1beta2 VERSION = 'V1beta2' - REVISION = '20200309' + REVISION = '20200414' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/memcache_v1beta2/classes.rb b/generated/google/apis/memcache_v1beta2/classes.rb index fcb946f9c..84c5157bb 100644 --- a/generated/google/apis/memcache_v1beta2/classes.rb +++ b/generated/google/apis/memcache_v1beta2/classes.rb @@ -369,12 +369,12 @@ module Google class GoogleCloudMemcacheV1beta2OperationMetadata include Google::Apis::Core::Hashable - # API version used to start the operation. + # Output only. API version used to start the operation. # Corresponds to the JSON property `apiVersion` # @return [String] attr_accessor :api_version - # Identifies whether the user has requested cancellation + # Output only. Identifies whether the user has requested cancellation # of the operation. Operations that have successfully been cancelled # have Operation.error value with a google.rpc.Status.code of 1, # corresponding to `Code.CANCELLED`. @@ -383,27 +383,27 @@ module Google attr_accessor :cancel_requested alias_method :cancel_requested?, :cancel_requested - # Time when the operation was created. + # Output only. Time when the operation was created. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time - # Time when the operation finished running. + # Output only. Time when the operation finished running. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Human-readable status of the operation, if any. + # Output only. Human-readable status of the operation, if any. # Corresponds to the JSON property `statusDetail` # @return [String] attr_accessor :status_detail - # Server-defined resource path for the target of the operation. + # Output only. Server-defined resource path for the target of the operation. # Corresponds to the JSON property `target` # @return [String] attr_accessor :target - # Name of the verb executed by the operation. + # Output only. Name of the verb executed by the operation. # Corresponds to the JSON property `verb` # @return [String] attr_accessor :verb diff --git a/generated/google/apis/memcache_v1beta2/service.rb b/generated/google/apis/memcache_v1beta2/service.rb index 9c4bd4f15..2a4bd87ec 100644 --- a/generated/google/apis/memcache_v1beta2/service.rb +++ b/generated/google/apis/memcache_v1beta2/service.rb @@ -199,7 +199,7 @@ module Google # Deletes a single Instance. # @param [String] name - # Memcached instance resource name in the format: + # Required. Memcached instance resource name in the format: # `projects/`project_id`/locations/`location_id`/instances/`instance_id`` # where `location_id` refers to a GCP region # @param [String] fields diff --git a/generated/google/apis/ml_v1.rb b/generated/google/apis/ml_v1.rb index dc521ddba..8607dd6e0 100644 --- a/generated/google/apis/ml_v1.rb +++ b/generated/google/apis/ml_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/ml/ module MlV1 VERSION = 'V1' - REVISION = '20200328' + REVISION = '20200413' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/ml_v1/classes.rb b/generated/google/apis/ml_v1/classes.rb index ee974782e..030fa5255 100644 --- a/generated/google/apis/ml_v1/classes.rb +++ b/generated/google/apis/ml_v1/classes.rb @@ -87,7 +87,7 @@ module Google class GoogleCloudMlV1AutomatedStoppingConfigDecayCurveAutomatedStoppingConfig include Google::Apis::Core::Hashable - # True if measurement.elapsed_time is used as the x-axis of each + # If true, measurement.elapsed_time is used as the x-axis of each # Trials Decay Curve. Otherwise, Measurement.steps will be used as the # x-axis. # Corresponds to the JSON property `useElapsedTime` @@ -113,10 +113,11 @@ module Google class GoogleCloudMlV1AutomatedStoppingConfigMedianAutomatedStoppingConfig include Google::Apis::Core::Hashable - # True if median automated stopping rule applies on - # measurement.use_elapsed_time. it means that elapsed_time field of - # latest measurement of current trial is used to compute median objective - # value for each completed trials. + # If true, the median automated stopping rule applies to + # measurement.use_elapsed_time, which means the elapsed_time field of + # the current trial's + # latest measurement is used to compute the median objective + # value for each completed trial. # Corresponds to the JSON property `useElapsedTime` # @return [Boolean] attr_accessor :use_elapsed_time @@ -443,7 +444,8 @@ module Google end end - # A message representing a parameter to be tuned. + # A message representing a parameter to be tuned. Contains the name of + # the parameter and the suggested value to use for this trial. class GoogleCloudMlV1TrialParameter include Google::Apis::Core::Hashable @@ -513,7 +515,7 @@ module Google class GoogleCloudMlV1AddTrialMeasurementRequest include Google::Apis::Core::Hashable - # A message representing a Measurement. + # A message representing a measurement. # Corresponds to the JSON property `measurement` # @return [Google::Apis::MlV1::GoogleCloudMlV1Measurement] attr_accessor :measurement @@ -702,7 +704,7 @@ module Google class GoogleCloudMlV1CheckTrialEarlyStoppingStateMetatdata include Google::Apis::Core::Hashable - # The time operation was submitted. + # The time at which the operation was submitted. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time @@ -712,7 +714,7 @@ module Google # @return [String] attr_accessor :study - # The Trial name. + # The trial name. # Corresponds to the JSON property `trial` # @return [String] attr_accessor :trial @@ -748,7 +750,7 @@ module Google class GoogleCloudMlV1CheckTrialEarlyStoppingStateResponse include Google::Apis::Core::Hashable - # The time operation processing completed. + # The time at which operation processing completed. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time @@ -759,7 +761,7 @@ module Google attr_accessor :should_stop alias_method :should_stop?, :should_stop - # The time operation was started. + # The time at which the operation was started. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -780,12 +782,12 @@ module Google class GoogleCloudMlV1CompleteTrialRequest include Google::Apis::Core::Hashable - # A message representing a Measurement. + # A message representing a measurement. # Corresponds to the JSON property `finalMeasurement` # @return [Google::Apis::MlV1::GoogleCloudMlV1Measurement] attr_accessor :final_measurement - # Optional. A human readable reason why the Trial was infeasible. This should + # Optional. A human readable reason why the trial was infeasible. This should # only be provided if `trial_infeasible` is true. # Corresponds to the JSON property `infeasibleReason` # @return [String] @@ -834,9 +836,11 @@ module Google class GoogleCloudMlV1EncryptionConfig include Google::Apis::Core::Hashable - # The Cloud KMS resource identifier of the customer managed encryption key - # used to protect a resource, such as a training job. Has the form: - # `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. + # The Cloud KMS resource identifier of the customer-managed encryption key + # used to protect a resource, such as a training job. It has the following + # format: + # `projects/`PROJECT_ID`/locations/`REGION`/keyRings/`KEY_RING_NAME`/cryptoKeys/` + # KEY_NAME`` # Corresponds to the JSON property `kmsKeyName` # @return [String] attr_accessor :kms_key_name @@ -1341,7 +1345,7 @@ module Google class GoogleCloudMlV1ListStudiesResponse include Google::Apis::Core::Hashable - # The Studies associated with the project. + # The studies associated with the project. # Corresponds to the JSON property `studies` # @return [Array] attr_accessor :studies @@ -1448,11 +1452,12 @@ module Google end end - # A message representing a Measurement. + # A message representing a measurement. class GoogleCloudMlV1Measurement include Google::Apis::Core::Hashable - # Time that the Trial has been running at the point of this Measurement. + # Output only. Time that the trial has been running at the point of + # this measurement. # Corresponds to the JSON property `elapsedTime` # @return [String] attr_accessor :elapsed_time @@ -2110,7 +2115,7 @@ module Google class GoogleCloudMlV1Study include Google::Apis::Core::Hashable - # Output only. Time that the study was created. + # Output only. Time at which the study was created. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time @@ -2165,7 +2170,7 @@ module Google # @return [Google::Apis::MlV1::GoogleCloudMlV1AutomatedStoppingConfig] attr_accessor :automated_stopping_config - # + # Metric specs for the study. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics @@ -2259,12 +2264,12 @@ module Google class GoogleCloudMlV1SuggestTrialsResponse include Google::Apis::Core::Hashable - # The time operation processing completed. + # The time at which operation processing completed. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # The time operation was started. + # The time at which the operation was started. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -2274,7 +2279,7 @@ module Google # @return [String] attr_accessor :study_state - # A list of Trials. + # A list of trials. # Corresponds to the JSON property `trials` # @return [Array] attr_accessor :trials @@ -2300,12 +2305,11 @@ module Google class GoogleCloudMlV1TrainingInput include Google::Apis::Core::Hashable - # Optional. Arguments passed to the training. - # - If it is a python package training: - # It will be passed as command line argument to the program. - # - If it is a custom container training, - # It will be passed as an argument to the custom container - # image. + # Optional. Command-line arguments passed to the training application when it + # starts. If your job uses a custom container, then the arguments are passed + # to the container's + # `ENTRYPOINT` command. # Corresponds to the JSON property `args` # @return [Array] attr_accessor :args @@ -2630,7 +2634,7 @@ module Google end end - # A message representing a Trial. + # A message representing a trial. class GoogleCloudMlV1Trial include Google::Apis::Core::Hashable @@ -2639,17 +2643,17 @@ module Google # @return [String] attr_accessor :client_id - # Output only. Time the Trial's status changed to COMPLETED. + # Output only. Time at which the trial's status changed to COMPLETED. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # A message representing a Measurement. + # A message representing a measurement. # Corresponds to the JSON property `finalMeasurement` # @return [Google::Apis::MlV1::GoogleCloudMlV1Measurement] attr_accessor :final_measurement - # Output only. A human readable string describing why the Trial is + # Output only. A human readable string describing why the trial is # infeasible. This should only be set if trial_infeasible is true. # Corresponds to the JSON property `infeasibleReason` # @return [String] @@ -2667,12 +2671,12 @@ module Google # @return [String] attr_accessor :name - # The parameters of the Trial. + # The parameters of the trial. # Corresponds to the JSON property `parameters` # @return [Array] attr_accessor :parameters - # Output only. Time the Trial was started. + # Output only. Time at which the trial was started. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -2682,8 +2686,7 @@ module Google # @return [String] attr_accessor :state - # Output only. True if the parameters in this trial should not be attempted - # again. + # Output only. If true, the parameters in this trial are not attempted again. # Corresponds to the JSON property `trialInfeasible` # @return [Boolean] attr_accessor :trial_infeasible diff --git a/generated/google/apis/ml_v1/service.rb b/generated/google/apis/ml_v1/service.rb index 5d281e6ad..36fb7fad6 100644 --- a/generated/google/apis/ml_v1/service.rb +++ b/generated/google/apis/ml_v1/service.rb @@ -744,8 +744,8 @@ module Google execute_or_queue_command(command, &block) end - # Adds a measurement of the objective metrics to a Trial. This measurement - # is assumed to have been taken before the Trial is complete. + # Adds a measurement of the objective metrics to a trial. This measurement + # is assumed to have been taken before the trial is complete. # @param [String] name # Required. The trial name. # @param [Google::Apis::MlV1::GoogleCloudMlV1AddTrialMeasurementRequest] google_cloud_ml_v1__add_trial_measurement_request_object @@ -778,7 +778,10 @@ module Google execute_or_queue_command(command, &block) end - # Checks whether a trial should stop or not. + # Checks whether a trial should stop or not. Returns a + # long-running operation. When the operation is successful, + # it will contain a + # CheckTrialEarlyStoppingStateResponse. # @param [String] name # Required. The trial name. # @param [Google::Apis::MlV1::GoogleCloudMlV1CheckTrialEarlyStoppingStateRequest] google_cloud_ml_v1__check_trial_early_stopping_state_request_object @@ -811,9 +814,9 @@ module Google execute_or_queue_command(command, &block) end - # Marks a Trial as complete. + # Marks a trial as complete. # @param [String] name - # Required. The trial name. + # Required. The trial name.metat # @param [Google::Apis::MlV1::GoogleCloudMlV1CompleteTrialRequest] google_cloud_ml_v1__complete_trial_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -844,7 +847,7 @@ module Google execute_or_queue_command(command, &block) end - # Adds a user provided trial to a Study. + # Adds a user provided trial to a study. # @param [String] parent # Required. The name of the study that the trial belongs to. # @param [Google::Apis::MlV1::GoogleCloudMlV1Trial] google_cloud_ml_v1__trial_object @@ -877,7 +880,7 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a Trial. + # Deletes a trial. # @param [String] name # Required. The trial name. # @param [String] fields @@ -907,7 +910,7 @@ module Google execute_or_queue_command(command, &block) end - # Gets a Trial. + # Gets a trial. # @param [String] name # Required. The trial name. # @param [String] fields @@ -937,7 +940,7 @@ module Google execute_or_queue_command(command, &block) end - # Lists the trials associated with a Study. + # Lists the trials associated with a study. # @param [String] parent # Required. The name of the study that the trial belongs to. # @param [String] fields @@ -1000,8 +1003,11 @@ module Google execute_or_queue_command(command, &block) end - # Returns a long-running operation associated with the generation of trial - # suggestions. + # Adds one or more trials to a study, with parameter values + # suggested by AI Platform Optimizer. Returns a long-running + # operation associated with the generation of trial suggestions. + # When this long-running operation succeeds, it will contain + # a SuggestTrialsResponse. # @param [String] parent # Required. The name of the study that the trial belongs to. # @param [Google::Apis::MlV1::GoogleCloudMlV1SuggestTrialsRequest] google_cloud_ml_v1__suggest_trials_request_object diff --git a/generated/google/apis/monitoring_v3.rb b/generated/google/apis/monitoring_v3.rb index a97878d3b..ef9f41aaf 100644 --- a/generated/google/apis/monitoring_v3.rb +++ b/generated/google/apis/monitoring_v3.rb @@ -29,7 +29,7 @@ module Google # @see https://cloud.google.com/monitoring/api/ module MonitoringV3 VERSION = 'V3' - REVISION = '20200329' + REVISION = '20200420' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/monitoring_v3/classes.rb b/generated/google/apis/monitoring_v3/classes.rb index beb13ab06..bc075cac3 100644 --- a/generated/google/apis/monitoring_v3/classes.rb +++ b/generated/google/apis/monitoring_v3/classes.rb @@ -651,12 +651,6 @@ module Google # @return [Google::Apis::MonitoringV3::MetricThreshold] attr_accessor :condition_threshold - # A condition type that allows alert policies to be defined using Monitoring - # Query Language. - # Corresponds to the JSON property `conditionTimeSeriesQueryLanguage` - # @return [Google::Apis::MonitoringV3::TimeSeriesQueryLanguageCondition] - attr_accessor :condition_time_series_query_language - # A short name or phrase used to identify the condition in dashboards, # notifications, and incidents. To avoid confusion, don't use the same display # name for multiple conditions in the same policy. @@ -691,7 +685,6 @@ module Google def update!(**args) @condition_absent = args[:condition_absent] if args.key?(:condition_absent) @condition_threshold = args[:condition_threshold] if args.key?(:condition_threshold) - @condition_time_series_query_language = args[:condition_time_series_query_language] if args.key?(:condition_time_series_query_language) @display_name = args[:display_name] if args.key?(:display_name) @name = args[:name] if args.key?(:name) end @@ -1442,6 +1435,21 @@ module Google # @return [Google::Apis::MonitoringV3::BasicAuthentication] attr_accessor :auth_info + # The request body associated with the HTTP request. If content_type is + # URL_ENCODED, the body passed in must be URL-encoded. Users can provide a + # Content-Length header via the headers field or the API will do so. The maximum + # byte size is 1 megabyte. Note: As with all bytes fields JSON representations + # are base64 encoded. + # Corresponds to the JSON property `body` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :body + + # The content type to use for the check. + # Corresponds to the JSON property `contentType` + # @return [String] + attr_accessor :content_type + # The list of headers to send as part of the Uptime check request. If two # headers have the same key and different values, they should be entered as a # single header, with the value being a comma-separated list of all the desired @@ -1479,6 +1487,12 @@ module Google # @return [Fixnum] attr_accessor :port + # The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED + # then request_method defaults to GET. + # Corresponds to the JSON property `requestMethod` + # @return [String] + attr_accessor :request_method + # If true, use HTTPS instead of HTTP to run the check. # Corresponds to the JSON property `useSsl` # @return [Boolean] @@ -1500,10 +1514,13 @@ module Google # Update properties of this object def update!(**args) @auth_info = args[:auth_info] if args.key?(:auth_info) + @body = args[:body] if args.key?(:body) + @content_type = args[:content_type] if args.key?(:content_type) @headers = args[:headers] if args.key?(:headers) @mask_headers = args[:mask_headers] if args.key?(:mask_headers) @path = args[:path] if args.key?(:path) @port = args[:port] if args.key?(:port) + @request_method = args[:request_method] if args.key?(:request_method) @use_ssl = args[:use_ssl] if args.key?(:use_ssl) @validate_ssl = args[:validate_ssl] if args.key?(:validate_ssl) end @@ -2908,7 +2925,7 @@ module Google # For DELTA and CUMULATIVE metrics, the start time must be earlier than the end # time. # In all cases, the start time of the next interval must be at least a - # microsecond after the end time of the previous interval. Because the interval + # millisecond after the end time of the previous interval. Because the interval # is closed, if the start time of a new interval is the same as the end time of # the previous interval, data written at the new start time could overwrite # data written at the previous end time. @@ -2950,7 +2967,7 @@ module Google # For DELTA and CUMULATIVE metrics, the start time must be earlier than the end # time. # In all cases, the start time of the next interval must be at least a - # microsecond after the end time of the previous interval. Because the interval + # millisecond after the end time of the previous interval. Because the interval # is closed, if the start time of a new interval is the same as the end time of # the previous interval, data written at the new start time could overwrite # data written at the previous end time. @@ -3476,7 +3493,7 @@ module Google # For DELTA and CUMULATIVE metrics, the start time must be earlier than the end # time. # In all cases, the start time of the next interval must be at least a - # microsecond after the end time of the previous interval. Because the interval + # millisecond after the end time of the previous interval. Because the interval # is closed, if the start time of a new interval is the same as the end time of # the previous interval, data written at the new start time could overwrite # data written at the previous end time. @@ -3641,34 +3658,6 @@ module Google end end - # A condition type that allows alert policies to be defined using Monitoring - # Query Language. - class TimeSeriesQueryLanguageCondition - include Google::Apis::Core::Hashable - - # Monitoring Query Language query that generates time series data and describes - # a condition for alerting on that data. - # Corresponds to the JSON property `query` - # @return [String] - attr_accessor :query - - # A short explanation of what the query represents. For example:"Error ratio - # exceeds 15% for >5% of servers in >2 regions" - # 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) - @query = args[:query] if args.key?(:query) - @summary = args[:summary] if args.key?(:summary) - end - end - # A TimeSeriesRatio specifies two TimeSeries to use for computing the # good_service / total_service ratio. The specified TimeSeries must have # ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = diff --git a/generated/google/apis/monitoring_v3/representations.rb b/generated/google/apis/monitoring_v3/representations.rb index 0d73141f2..d336a4bae 100644 --- a/generated/google/apis/monitoring_v3/representations.rb +++ b/generated/google/apis/monitoring_v3/representations.rb @@ -544,12 +544,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class TimeSeriesQueryLanguageCondition - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class TimeSeriesRatio class Representation < Google::Apis::Core::JsonRepresentation; end @@ -752,8 +746,6 @@ module Google property :condition_threshold, as: 'conditionThreshold', class: Google::Apis::MonitoringV3::MetricThreshold, decorator: Google::Apis::MonitoringV3::MetricThreshold::Representation - property :condition_time_series_query_language, as: 'conditionTimeSeriesQueryLanguage', class: Google::Apis::MonitoringV3::TimeSeriesQueryLanguageCondition, decorator: Google::Apis::MonitoringV3::TimeSeriesQueryLanguageCondition::Representation - property :display_name, as: 'displayName' property :name, as: 'name' end @@ -948,10 +940,13 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :auth_info, as: 'authInfo', class: Google::Apis::MonitoringV3::BasicAuthentication, decorator: Google::Apis::MonitoringV3::BasicAuthentication::Representation + property :body, :base64 => true, as: 'body' + property :content_type, as: 'contentType' hash :headers, as: 'headers' property :mask_headers, as: 'maskHeaders' property :path, as: 'path' property :port, as: 'port' + property :request_method, as: 'requestMethod' property :use_ssl, as: 'useSsl' property :validate_ssl, as: 'validateSsl' end @@ -1481,14 +1476,6 @@ module Google end end - class TimeSeriesQueryLanguageCondition - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :query, as: 'query' - property :summary, as: 'summary' - end - end - class TimeSeriesRatio # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/monitoring_v3/service.rb b/generated/google/apis/monitoring_v3/service.rb index 1fe2d151f..5e521c5fd 100644 --- a/generated/google/apis/monitoring_v3/service.rb +++ b/generated/google/apis/monitoring_v3/service.rb @@ -56,10 +56,11 @@ module Google # Required. The project in which to create the alerting policy. The format is: # projects/[PROJECT_ID_OR_NUMBER] # Note that this field names the parent container in which the alerting policy - # will be written, not the name of the created policy. The alerting policy that - # is returned will have a name that contains a normalized representation of this - # name as a prefix but adds a suffix of the form /alertPolicies/[ALERT_POLICY_ID] - # , identifying the policy in the container. + # will be written, not the name of the created policy. |name| must be a host + # project of a workspace, otherwise INVALID_ARGUMENT error will return. The + # alerting policy that is returned will have a name that contains a normalized + # representation of this name as a prefix but adds a suffix of the form / + # alertPolicies/[ALERT_POLICY_ID], identifying the policy in the container. # @param [Google::Apis::MonitoringV3::AlertPolicy] alert_policy_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -153,7 +154,7 @@ module Google execute_or_queue_command(command, &block) end - # Lists the existing alerting policies for the project. + # Lists the existing alerting policies for the workspace. # @param [String] name # Required. The project whose alert policies are to be listed. The format is: # projects/[PROJECT_ID_OR_NUMBER] diff --git a/generated/google/apis/osconfig_v1beta/classes.rb b/generated/google/apis/osconfig_v1beta/classes.rb deleted file mode 100644 index 06e18f66f..000000000 --- a/generated/google/apis/osconfig_v1beta/classes.rb +++ /dev/null @@ -1,2365 +0,0 @@ -# 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 OsconfigV1beta - - # Represents a single Apt package repository. This repository is added to - # a repo file that is stored at - # `/etc/apt/sources.list.d/google_osconfig.list`. - class AptRepository - include Google::Apis::Core::Hashable - - # Type of archive files in this repository. The default behavior is DEB. - # Corresponds to the JSON property `archiveType` - # @return [String] - attr_accessor :archive_type - - # Required. List of components for this repository. Must contain at least one - # item. - # Corresponds to the JSON property `components` - # @return [Array] - attr_accessor :components - - # Required. Distribution of this repository. - # Corresponds to the JSON property `distribution` - # @return [String] - attr_accessor :distribution - - # URI of the key file for this repository. The agent maintains - # a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg` containing - # all the keys in any applied guest policy. - # Corresponds to the JSON property `gpgKey` - # @return [String] - attr_accessor :gpg_key - - # Required. URI for this repository. - # Corresponds to the JSON property `uri` - # @return [String] - attr_accessor :uri - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @archive_type = args[:archive_type] if args.key?(:archive_type) - @components = args[:components] if args.key?(:components) - @distribution = args[:distribution] if args.key?(:distribution) - @gpg_key = args[:gpg_key] if args.key?(:gpg_key) - @uri = args[:uri] if args.key?(:uri) - end - end - - # Apt patching is completed by executing `apt-get update && apt-get - # upgrade`. Additional options can be set to control how this is executed. - class AptSettings - include Google::Apis::Core::Hashable - - # List of packages to exclude from update. These packages will be excluded - # Corresponds to the JSON property `excludes` - # @return [Array] - attr_accessor :excludes - - # An exclusive list of packages to be updated. These are the only packages - # that will be updated. If these packages are not installed, they will be - # ignored. This field cannot be specified with any other patch configuration - # fields. - # Corresponds to the JSON property `exclusivePackages` - # @return [Array] - attr_accessor :exclusive_packages - - # By changing the type to DIST, the patching is performed - # using `apt-get dist-upgrade` instead. - # 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) - @excludes = args[:excludes] if args.key?(:excludes) - @exclusive_packages = args[:exclusive_packages] if args.key?(:exclusive_packages) - @type = args[:type] if args.key?(:type) - end - end - - # An assignment represents the group or groups of VM instances that the policy - # applies to. - # If an assignment is empty, it applies to all VM instances. Otherwise, the - # targeted VM instances must meet all the criteria specified. So if both - # labels and zones are specified, the policy applies to VM instances with those - # labels and in those zones. - class Assignment - include Google::Apis::Core::Hashable - - # Targets instances matching at least one of these label sets. This allows - # an assignment to target disparate groups, for example "env=prod or - # env=staging". - # Corresponds to the JSON property `groupLabels` - # @return [Array] - attr_accessor :group_labels - - # Targets VM instances whose name starts with one of these prefixes. - # Like labels, this is another way to group VM instances when targeting - # configs, for example prefix="prod-". - # Only supported for project-level policies. - # Corresponds to the JSON property `instanceNamePrefixes` - # @return [Array] - attr_accessor :instance_name_prefixes - - # Targets any of the instances specified. Instances are specified by their - # URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`. - # Instance targeting is uncommon and is supported to facilitate the - # management of changes by the instance or to target specific VM instances - # for development and testing. - # Only supported for project-level policies and must reference instances - # within this project. - # Corresponds to the JSON property `instances` - # @return [Array] - attr_accessor :instances - - # Targets VM instances matching at least one of the following OS types. - # VM instances must match all supplied criteria for a given OsType to be - # included. - # Corresponds to the JSON property `osTypes` - # @return [Array] - attr_accessor :os_types - - # Targets instances in any of these zones. Leave empty to target instances - # in any zone. - # Zonal targeting is uncommon and is supported to facilitate the management - # of changes by zone. - # Corresponds to the JSON property `zones` - # @return [Array] - attr_accessor :zones - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @group_labels = args[:group_labels] if args.key?(:group_labels) - @instance_name_prefixes = args[:instance_name_prefixes] if args.key?(:instance_name_prefixes) - @instances = args[:instances] if args.key?(:instances) - @os_types = args[:os_types] if args.key?(:os_types) - @zones = args[:zones] if args.key?(:zones) - end - end - - # Represents a group of VM intances that can be identified as having all - # these labels, for example "env=prod and app=web". - class AssignmentGroupLabel - include Google::Apis::Core::Hashable - - # Google Compute Engine instance labels that must be present for an - # instance to be included in this assignment group. - # Corresponds to the JSON property `labels` - # @return [Hash] - attr_accessor :labels - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @labels = args[:labels] if args.key?(:labels) - end - end - - # Defines the criteria for selecting VM Instances by OS type. - class AssignmentOsType - include Google::Apis::Core::Hashable - - # Targets VM instances with OS Inventory enabled and having the following - # OS architecture. - # Corresponds to the JSON property `osArchitecture` - # @return [String] - attr_accessor :os_architecture - - # Targets VM instances with OS Inventory enabled and having the following - # OS short name, for example "debian" or "windows". - # Corresponds to the JSON property `osShortName` - # @return [String] - attr_accessor :os_short_name - - # Targets VM instances with OS Inventory enabled and having the following - # following OS version. - # Corresponds to the JSON property `osVersion` - # @return [String] - attr_accessor :os_version - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @os_architecture = args[:os_architecture] if args.key?(:os_architecture) - @os_short_name = args[:os_short_name] if args.key?(:os_short_name) - @os_version = args[:os_version] if args.key?(:os_version) - end - end - - # Message for canceling a patch job. - class CancelPatchJobRequest - include Google::Apis::Core::Hashable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - end - end - - # The effective guest policy that applies to a VM instance. - class EffectiveGuestPolicy - include Google::Apis::Core::Hashable - - # List of package repository configurations assigned to the VM instance. - # Corresponds to the JSON property `packageRepositories` - # @return [Array] - attr_accessor :package_repositories - - # List of package configurations assigned to the VM instance. - # Corresponds to the JSON property `packages` - # @return [Array] - attr_accessor :packages - - # List of recipes assigned to the VM instance. - # Corresponds to the JSON property `softwareRecipes` - # @return [Array] - attr_accessor :software_recipes - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @package_repositories = args[:package_repositories] if args.key?(:package_repositories) - @packages = args[:packages] if args.key?(:packages) - @software_recipes = args[:software_recipes] if args.key?(:software_recipes) - end - end - - # A guest policy package including its source. - class EffectiveGuestPolicySourcedPackage - include Google::Apis::Core::Hashable - - # Package is a reference to the software package to be installed or removed. - # The agent on the VM instance uses the system package manager to apply the - # config. - # These are the commands that the agent uses to install or remove - # packages. - # Apt - # install: `apt-get update && apt-get -y install package1 package2 package3` - # remove: `apt-get -y remove package1 package2 package3` - # Yum - # install: `yum -y install package1 package2 package3` - # remove: `yum -y remove package1 package2 package3` - # Zypper - # install: `zypper install package1 package2 package3` - # remove: `zypper rm package1 package2` - # Googet - # install: `googet -noconfirm install package1 package2 package3` - # remove: `googet -noconfirm remove package1 package2 package3` - # Corresponds to the JSON property `package` - # @return [Google::Apis::OsconfigV1beta::Package] - attr_accessor :package - - # Name of the guest policy providing this config. - # Corresponds to the JSON property `source` - # @return [String] - attr_accessor :source - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @package = args[:package] if args.key?(:package) - @source = args[:source] if args.key?(:source) - end - end - - # A guest policy package repository including its source. - class EffectiveGuestPolicySourcedPackageRepository - include Google::Apis::Core::Hashable - - # A package repository. - # Corresponds to the JSON property `packageRepository` - # @return [Google::Apis::OsconfigV1beta::PackageRepository] - attr_accessor :package_repository - - # Name of the guest policy providing this config. - # Corresponds to the JSON property `source` - # @return [String] - attr_accessor :source - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @package_repository = args[:package_repository] if args.key?(:package_repository) - @source = args[:source] if args.key?(:source) - end - end - - # A guest policy recipe including its source. - class EffectiveGuestPolicySourcedSoftwareRecipe - include Google::Apis::Core::Hashable - - # A software recipe is a set of instructions for installing and configuring a - # piece of software. It consists of a set of artifacts that are - # downloaded, and a set of steps that install, configure, and/or update the - # software. - # Recipes support installing and updating software from artifacts in the - # following formats: - # Zip archive, Tar archive, Windows MSI, Debian package, and RPM package. - # Additionally, recipes support executing a script (either defined in a file or - # directly in this api) in bash, sh, cmd, and powershell. - # Updating a software recipe - # If a recipe is assigned to an instance and there is a recipe with the same - # name but a lower version already installed and the assigned state - # of the recipe is `INSTALLED_KEEP_UPDATED`, then the recipe is updated to - # the new version. - # Script Working Directories - # Each script or execution step is run in its own temporary directory which - # is deleted after completing the step. - # Corresponds to the JSON property `softwareRecipe` - # @return [Google::Apis::OsconfigV1beta::SoftwareRecipe] - attr_accessor :software_recipe - - # Name of the guest policy providing this config. - # Corresponds to the JSON property `source` - # @return [String] - attr_accessor :source - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @software_recipe = args[:software_recipe] if args.key?(:software_recipe) - @source = args[:source] if args.key?(:source) - end - end - - # A generic empty message that you can re-use to avoid defining duplicated - # empty messages in your APIs. A typical example is to use it as the request - # or the response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for `Empty` is empty JSON object ````. - class Empty - include Google::Apis::Core::Hashable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - end - end - - # A step that runs an executable for a PatchJob. - class ExecStep - include Google::Apis::Core::Hashable - - # Common configurations for an ExecStep. - # Corresponds to the JSON property `linuxExecStepConfig` - # @return [Google::Apis::OsconfigV1beta::ExecStepConfig] - attr_accessor :linux_exec_step_config - - # Common configurations for an ExecStep. - # Corresponds to the JSON property `windowsExecStepConfig` - # @return [Google::Apis::OsconfigV1beta::ExecStepConfig] - attr_accessor :windows_exec_step_config - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @linux_exec_step_config = args[:linux_exec_step_config] if args.key?(:linux_exec_step_config) - @windows_exec_step_config = args[:windows_exec_step_config] if args.key?(:windows_exec_step_config) - end - end - - # Common configurations for an ExecStep. - class ExecStepConfig - include Google::Apis::Core::Hashable - - # Defaults to [0]. A list of possible return values that the - # execution can return to indicate a success. - # Corresponds to the JSON property `allowedSuccessCodes` - # @return [Array] - attr_accessor :allowed_success_codes - - # Google Cloud Storage object representation. - # Corresponds to the JSON property `gcsObject` - # @return [Google::Apis::OsconfigV1beta::GcsObject] - attr_accessor :gcs_object - - # The script interpreter to use to run the script. If no interpreter is - # specified the script will be executed directly, which will likely - # only succeed for scripts with [shebang lines] - # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). - # Corresponds to the JSON property `interpreter` - # @return [String] - attr_accessor :interpreter - - # An absolute path to the executable on the VM. - # Corresponds to the JSON property `localPath` - # @return [String] - attr_accessor :local_path - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @allowed_success_codes = args[:allowed_success_codes] if args.key?(:allowed_success_codes) - @gcs_object = args[:gcs_object] if args.key?(:gcs_object) - @interpreter = args[:interpreter] if args.key?(:interpreter) - @local_path = args[:local_path] if args.key?(:local_path) - end - end - - # A request message to initiate patching across Google Compute Engine - # instances. - class ExecutePatchJobRequest - include Google::Apis::Core::Hashable - - # Description of the patch job. Length of the description is limited - # to 1024 characters. - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # Display name for this patch job. This does not have to be unique. - # Corresponds to the JSON property `displayName` - # @return [String] - attr_accessor :display_name - - # If this patch is a dry-run only, instances are contacted but - # will do nothing. - # Corresponds to the JSON property `dryRun` - # @return [Boolean] - attr_accessor :dry_run - alias_method :dry_run?, :dry_run - - # Duration of the patch job. After the duration ends, the patch job - # times out. - # Corresponds to the JSON property `duration` - # @return [String] - attr_accessor :duration - - # A filter to target VM instances for patching. The targeted - # VMs must meet all criteria specified. So if both labels and zones are - # specified, the patch job targets only VMs with those labels and in those - # zones. - # Corresponds to the JSON property `instanceFilter` - # @return [Google::Apis::OsconfigV1beta::PatchInstanceFilter] - attr_accessor :instance_filter - - # Patch configuration specifications. Contains details on how to apply the - # patch(es) to a VM instance. - # Corresponds to the JSON property `patchConfig` - # @return [Google::Apis::OsconfigV1beta::PatchConfig] - attr_accessor :patch_config - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @description = args[:description] if args.key?(:description) - @display_name = args[:display_name] if args.key?(:display_name) - @dry_run = args[:dry_run] if args.key?(:dry_run) - @duration = args[:duration] if args.key?(:duration) - @instance_filter = args[:instance_filter] if args.key?(:instance_filter) - @patch_config = args[:patch_config] if args.key?(:patch_config) - end - end - - # Google Cloud Storage object representation. - class GcsObject - include Google::Apis::Core::Hashable - - # Required. Bucket of the Google Cloud Storage object. - # Corresponds to the JSON property `bucket` - # @return [String] - attr_accessor :bucket - - # Required. Generation number of the Google Cloud Storage object. This is used - # to - # ensure that the ExecStep specified by this PatchJob does not change. - # Corresponds to the JSON property `generationNumber` - # @return [Fixnum] - attr_accessor :generation_number - - # Required. Name of the Google Cloud Storage object. - # Corresponds to the JSON property `object` - # @return [String] - attr_accessor :object - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @bucket = args[:bucket] if args.key?(:bucket) - @generation_number = args[:generation_number] if args.key?(:generation_number) - @object = args[:object] if args.key?(:object) - end - end - - # Represents a Goo package repository. These is added to a repo file - # that is stored at C:/ProgramData/GooGet/repos/google_osconfig.repo. - class GooRepository - include Google::Apis::Core::Hashable - - # Required. The name of the repository. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Required. The url of the repository. - # Corresponds to the JSON property `url` - # @return [String] - attr_accessor :url - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @name = args[:name] if args.key?(:name) - @url = args[:url] if args.key?(:url) - end - end - - # Googet patching is performed by running `googet update`. - class GooSettings - include Google::Apis::Core::Hashable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - end - end - - # An OS Config resource representing a guest configuration policy. These - # policies represent the desired state for VM instance guest environments - # including packages to install or remove, package repository configurations, - # and software to install. - class GuestPolicy - include Google::Apis::Core::Hashable - - # An assignment represents the group or groups of VM instances that the policy - # applies to. - # If an assignment is empty, it applies to all VM instances. Otherwise, the - # targeted VM instances must meet all the criteria specified. So if both - # labels and zones are specified, the policy applies to VM instances with those - # labels and in those zones. - # Corresponds to the JSON property `assignment` - # @return [Google::Apis::OsconfigV1beta::Assignment] - attr_accessor :assignment - - # Output only. Time this guest policy was created. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # Description of the guest policy. Length of the description is limited - # to 1024 characters. - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # The etag for this guest policy. - # If this is provided on update, it must match the server's etag. - # Corresponds to the JSON property `etag` - # @return [String] - attr_accessor :etag - - # Required. Unique name of the resource in this project using one of the - # following - # forms: - # `projects/`project_number`/guestPolicies/`guest_policy_id``. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # A list of package repositories to configure on the VM instance. This is - # done before any other configs are applied so they can use these repos. - # Package repositories are only configured if the corresponding package - # manager(s) are available. - # Corresponds to the JSON property `packageRepositories` - # @return [Array] - attr_accessor :package_repositories - - # The software packages to be managed by this policy. - # Corresponds to the JSON property `packages` - # @return [Array] - attr_accessor :packages - - # A list of Recipes to install on the VM instance. - # Corresponds to the JSON property `recipes` - # @return [Array] - attr_accessor :recipes - - # Output only. Last time this guest policy was updated. - # Corresponds to the JSON property `updateTime` - # @return [String] - attr_accessor :update_time - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @assignment = args[:assignment] if args.key?(:assignment) - @create_time = args[:create_time] if args.key?(:create_time) - @description = args[:description] if args.key?(:description) - @etag = args[:etag] if args.key?(:etag) - @name = args[:name] if args.key?(:name) - @package_repositories = args[:package_repositories] if args.key?(:package_repositories) - @packages = args[:packages] if args.key?(:packages) - @recipes = args[:recipes] if args.key?(:recipes) - @update_time = args[:update_time] if args.key?(:update_time) - end - end - - # A response message for listing guest policies. - class ListGuestPoliciesResponse - include Google::Apis::Core::Hashable - - # The list of GuestPolicies. - # Corresponds to the JSON property `guestPolicies` - # @return [Array] - attr_accessor :guest_policies - - # A pagination token that can be used to get the next page - # of guest policies. - # 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) - @guest_policies = args[:guest_policies] if args.key?(:guest_policies) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # A response message for listing patch deployments. - class ListPatchDeploymentsResponse - include Google::Apis::Core::Hashable - - # A pagination token that can be used to get the next page of patch - # deployments. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # The list of patch deployments. - # Corresponds to the JSON property `patchDeployments` - # @return [Array] - attr_accessor :patch_deployments - - 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) - @patch_deployments = args[:patch_deployments] if args.key?(:patch_deployments) - end - end - - # A response message for listing the instances details for a patch job. - class ListPatchJobInstanceDetailsResponse - include Google::Apis::Core::Hashable - - # A pagination token that can be used to get the next page of results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # A list of instance status. - # Corresponds to the JSON property `patchJobInstanceDetails` - # @return [Array] - attr_accessor :patch_job_instance_details - - 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) - @patch_job_instance_details = args[:patch_job_instance_details] if args.key?(:patch_job_instance_details) - end - end - - # A response message for listing patch jobs. - class ListPatchJobsResponse - include Google::Apis::Core::Hashable - - # A pagination token that can be used to get the next page of results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # The list of patch jobs. - # Corresponds to the JSON property `patchJobs` - # @return [Array] - attr_accessor :patch_jobs - - 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) - @patch_jobs = args[:patch_jobs] if args.key?(:patch_jobs) - end - end - - # A request message for getting the effective guest policy assigned to the - # instance. - class LookupEffectiveGuestPolicyRequest - include Google::Apis::Core::Hashable - - # Architecture of OS running on the instance. The OS Config agent only - # provides this field for targeting if OS Inventory is enabled for that - # instance. - # Corresponds to the JSON property `osArchitecture` - # @return [String] - attr_accessor :os_architecture - - # Short name of the OS running on the instance. The OS Config agent only - # provides this field for targeting if OS Inventory is enabled for that - # instance. - # Corresponds to the JSON property `osShortName` - # @return [String] - attr_accessor :os_short_name - - # Version of the OS running on the instance. The OS Config agent only - # provides this field for targeting if OS Inventory is enabled for that - # VM instance. - # Corresponds to the JSON property `osVersion` - # @return [String] - attr_accessor :os_version - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @os_architecture = args[:os_architecture] if args.key?(:os_architecture) - @os_short_name = args[:os_short_name] if args.key?(:os_short_name) - @os_version = args[:os_version] if args.key?(:os_version) - end - end - - # Represents a monthly schedule. An example of a valid monthly schedule is - # "on the third Tuesday of the month" or "on the 15th of the month". - class MonthlySchedule - include Google::Apis::Core::Hashable - - # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 - # indicates the last day of the month. - # Months without the target day will be skipped. For example, a schedule to - # run "every month on the 31st" will not run in February, April, June, etc. - # Corresponds to the JSON property `monthDay` - # @return [Fixnum] - attr_accessor :month_day - - # Represents one week day in a month. An example is "the 4th Sunday". - # Corresponds to the JSON property `weekDayOfMonth` - # @return [Google::Apis::OsconfigV1beta::WeekDayOfMonth] - attr_accessor :week_day_of_month - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @month_day = args[:month_day] if args.key?(:month_day) - @week_day_of_month = args[:week_day_of_month] if args.key?(:week_day_of_month) - end - end - - # Sets the time for a one time patch deployment. Timestamp is in - # RFC3339 - # text format. - class OneTimeSchedule - include Google::Apis::Core::Hashable - - # Required. The desired patch job execution time. - # Corresponds to the JSON property `executeTime` - # @return [String] - attr_accessor :execute_time - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @execute_time = args[:execute_time] if args.key?(:execute_time) - end - end - - # Package is a reference to the software package to be installed or removed. - # The agent on the VM instance uses the system package manager to apply the - # config. - # These are the commands that the agent uses to install or remove - # packages. - # Apt - # install: `apt-get update && apt-get -y install package1 package2 package3` - # remove: `apt-get -y remove package1 package2 package3` - # Yum - # install: `yum -y install package1 package2 package3` - # remove: `yum -y remove package1 package2 package3` - # Zypper - # install: `zypper install package1 package2 package3` - # remove: `zypper rm package1 package2` - # Googet - # install: `googet -noconfirm install package1 package2 package3` - # remove: `googet -noconfirm remove package1 package2 package3` - class Package - include Google::Apis::Core::Hashable - - # The desired_state the agent should maintain for this package. The - # default is to ensure the package is installed. - # Corresponds to the JSON property `desiredState` - # @return [String] - attr_accessor :desired_state - - # Type of package manager that can be used to install this package. - # If a system does not have the package manager, the package is not - # installed or removed no error message is returned. By default, - # or if you specify `ANY`, - # the agent attempts to install and remove this package using the default - # package manager. This is useful when creating a policy that applies to - # different types of systems. - # The default behavior is ANY. - # Corresponds to the JSON property `manager` - # @return [String] - attr_accessor :manager - - # Required. The name of the package. A package is uniquely identified for - # conflict - # validation by checking the package name and the manager(s) that the - # package targets. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @desired_state = args[:desired_state] if args.key?(:desired_state) - @manager = args[:manager] if args.key?(:manager) - @name = args[:name] if args.key?(:name) - end - end - - # A package repository. - class PackageRepository - include Google::Apis::Core::Hashable - - # Represents a single Apt package repository. This repository is added to - # a repo file that is stored at - # `/etc/apt/sources.list.d/google_osconfig.list`. - # Corresponds to the JSON property `apt` - # @return [Google::Apis::OsconfigV1beta::AptRepository] - attr_accessor :apt - - # Represents a Goo package repository. These is added to a repo file - # that is stored at C:/ProgramData/GooGet/repos/google_osconfig.repo. - # Corresponds to the JSON property `goo` - # @return [Google::Apis::OsconfigV1beta::GooRepository] - attr_accessor :goo - - # Represents a single Yum package repository. This repository is added to a - # repo file that is stored at `/etc/yum.repos.d/google_osconfig.repo`. - # Corresponds to the JSON property `yum` - # @return [Google::Apis::OsconfigV1beta::YumRepository] - attr_accessor :yum - - # Represents a single Zypper package repository. This repository is added to a - # repo file that is stored at `/etc/zypp/repos.d/google_osconfig.repo`. - # Corresponds to the JSON property `zypper` - # @return [Google::Apis::OsconfigV1beta::ZypperRepository] - attr_accessor :zypper - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @apt = args[:apt] if args.key?(:apt) - @goo = args[:goo] if args.key?(:goo) - @yum = args[:yum] if args.key?(:yum) - @zypper = args[:zypper] if args.key?(:zypper) - end - end - - # Patch configuration specifications. Contains details on how to apply the - # patch(es) to a VM instance. - class PatchConfig - include Google::Apis::Core::Hashable - - # Apt patching is completed by executing `apt-get update && apt-get - # upgrade`. Additional options can be set to control how this is executed. - # Corresponds to the JSON property `apt` - # @return [Google::Apis::OsconfigV1beta::AptSettings] - attr_accessor :apt - - # Googet patching is performed by running `googet update`. - # Corresponds to the JSON property `goo` - # @return [Google::Apis::OsconfigV1beta::GooSettings] - attr_accessor :goo - - # A step that runs an executable for a PatchJob. - # Corresponds to the JSON property `postStep` - # @return [Google::Apis::OsconfigV1beta::ExecStep] - attr_accessor :post_step - - # A step that runs an executable for a PatchJob. - # Corresponds to the JSON property `preStep` - # @return [Google::Apis::OsconfigV1beta::ExecStep] - attr_accessor :pre_step - - # Post-patch reboot settings. - # Corresponds to the JSON property `rebootConfig` - # @return [String] - attr_accessor :reboot_config - - # Windows patching is performed using the Windows Update Agent. - # Corresponds to the JSON property `windowsUpdate` - # @return [Google::Apis::OsconfigV1beta::WindowsUpdateSettings] - attr_accessor :windows_update - - # Yum patching is performed by executing `yum update`. Additional options - # can be set to control how this is executed. - # Note that not all settings are supported on all platforms. - # Corresponds to the JSON property `yum` - # @return [Google::Apis::OsconfigV1beta::YumSettings] - attr_accessor :yum - - # Zypper patching is performed by running `zypper patch`. - # See also https://en.opensuse.org/SDB:Zypper_manual. - # Corresponds to the JSON property `zypper` - # @return [Google::Apis::OsconfigV1beta::ZypperSettings] - attr_accessor :zypper - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @apt = args[:apt] if args.key?(:apt) - @goo = args[:goo] if args.key?(:goo) - @post_step = args[:post_step] if args.key?(:post_step) - @pre_step = args[:pre_step] if args.key?(:pre_step) - @reboot_config = args[:reboot_config] if args.key?(:reboot_config) - @windows_update = args[:windows_update] if args.key?(:windows_update) - @yum = args[:yum] if args.key?(:yum) - @zypper = args[:zypper] if args.key?(:zypper) - end - end - - # Patch deployments are configurations that individual patch jobs use to - # complete a patch. These configurations include instance filter, package - # repository settings, and a schedule. For more information about creating and - # managing patch deployments, see [Scheduling patch - # jobs](/compute/docs/os-patch-management/schedule-patch-jobs). - class PatchDeployment - include Google::Apis::Core::Hashable - - # Output only. Time the patch deployment was created. Timestamp is in - # RFC3339 - # text format. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # Optional. Description of the patch deployment. Length of the description is - # limited - # to 1024 characters. - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # Optional. Duration of the patch. After the duration ends, the patch times out. - # Corresponds to the JSON property `duration` - # @return [String] - attr_accessor :duration - - # A filter to target VM instances for patching. The targeted - # VMs must meet all criteria specified. So if both labels and zones are - # specified, the patch job targets only VMs with those labels and in those - # zones. - # Corresponds to the JSON property `instanceFilter` - # @return [Google::Apis::OsconfigV1beta::PatchInstanceFilter] - attr_accessor :instance_filter - - # Output only. The last time a patch job was started by this deployment. - # Timestamp is in - # RFC3339 - # text format. - # Corresponds to the JSON property `lastExecuteTime` - # @return [String] - attr_accessor :last_execute_time - - # Unique name for the patch deployment resource in a project. The patch - # deployment name is in the form: - # `projects/`project_id`/patchDeployments/`patch_deployment_id``. - # This field is ignored when you create a new patch deployment. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Sets the time for a one time patch deployment. Timestamp is in - # RFC3339 - # text format. - # Corresponds to the JSON property `oneTimeSchedule` - # @return [Google::Apis::OsconfigV1beta::OneTimeSchedule] - attr_accessor :one_time_schedule - - # Patch configuration specifications. Contains details on how to apply the - # patch(es) to a VM instance. - # Corresponds to the JSON property `patchConfig` - # @return [Google::Apis::OsconfigV1beta::PatchConfig] - attr_accessor :patch_config - - # Sets the time for recurring patch deployments. - # Corresponds to the JSON property `recurringSchedule` - # @return [Google::Apis::OsconfigV1beta::RecurringSchedule] - attr_accessor :recurring_schedule - - # Output only. Time the patch deployment was last updated. Timestamp is in - # RFC3339 - # text format. - # Corresponds to the JSON property `updateTime` - # @return [String] - attr_accessor :update_time - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @create_time = args[:create_time] if args.key?(:create_time) - @description = args[:description] if args.key?(:description) - @duration = args[:duration] if args.key?(:duration) - @instance_filter = args[:instance_filter] if args.key?(:instance_filter) - @last_execute_time = args[:last_execute_time] if args.key?(:last_execute_time) - @name = args[:name] if args.key?(:name) - @one_time_schedule = args[:one_time_schedule] if args.key?(:one_time_schedule) - @patch_config = args[:patch_config] if args.key?(:patch_config) - @recurring_schedule = args[:recurring_schedule] if args.key?(:recurring_schedule) - @update_time = args[:update_time] if args.key?(:update_time) - end - end - - # A filter to target VM instances for patching. The targeted - # VMs must meet all criteria specified. So if both labels and zones are - # specified, the patch job targets only VMs with those labels and in those - # zones. - class PatchInstanceFilter - include Google::Apis::Core::Hashable - - # Target all VM instances in the project. If true, no other criteria is - # permitted. - # Corresponds to the JSON property `all` - # @return [Boolean] - attr_accessor :all - alias_method :all?, :all - - # Targets VM instances matching at least one of these label sets. This allows - # targeting of disparate groups, for example "env=prod or env=staging". - # Corresponds to the JSON property `groupLabels` - # @return [Array] - attr_accessor :group_labels - - # Targets VMs whose name starts with one of these prefixes. Similar to - # labels, this is another way to group VMs when targeting configs, for - # example prefix="prod-". - # Corresponds to the JSON property `instanceNamePrefixes` - # @return [Array] - attr_accessor :instance_name_prefixes - - # Targets any of the VM instances specified. Instances are specified by their - # URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME], - # `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or - # `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/ - # instances/[INSTANCE_NAME]` - # Corresponds to the JSON property `instances` - # @return [Array] - attr_accessor :instances - - # Targets VM instances in ANY of these zones. Leave empty to target VM - # instances in any zone. - # Corresponds to the JSON property `zones` - # @return [Array] - attr_accessor :zones - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @all = args[:all] if args.key?(:all) - @group_labels = args[:group_labels] if args.key?(:group_labels) - @instance_name_prefixes = args[:instance_name_prefixes] if args.key?(:instance_name_prefixes) - @instances = args[:instances] if args.key?(:instances) - @zones = args[:zones] if args.key?(:zones) - end - end - - # Represents a group of VMs that can be identified as having all these - # labels, for example "env=prod and app=web". - class PatchInstanceFilterGroupLabel - include Google::Apis::Core::Hashable - - # Google Compute Engine instance labels that must be present for a VM - # instance to be targeted by this filter. - # Corresponds to the JSON property `labels` - # @return [Hash] - attr_accessor :labels - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @labels = args[:labels] if args.key?(:labels) - end - end - - # A high level representation of a patch job that is either in progress - # or has completed. - # Instances details are not included in the job. To paginate through instance - # details, use ListPatchJobInstanceDetails. - # For more information about patch jobs, see - # [Creating patch jobs](/compute/docs/os-patch-management/create-patch-job). - class PatchJob - include Google::Apis::Core::Hashable - - # Time this patch job was created. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # Description of the patch job. Length of the description is limited - # to 1024 characters. - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # Display name for this patch job. This is not a unique identifier. - # Corresponds to the JSON property `displayName` - # @return [String] - attr_accessor :display_name - - # If this patch job is a dry run, the agent reports that it has - # finished without running any updates on the VM instance. - # Corresponds to the JSON property `dryRun` - # @return [Boolean] - attr_accessor :dry_run - alias_method :dry_run?, :dry_run - - # Duration of the patch job. After the duration ends, the - # patch job times out. - # Corresponds to the JSON property `duration` - # @return [String] - attr_accessor :duration - - # If this patch job failed, this message provides information about the - # failure. - # Corresponds to the JSON property `errorMessage` - # @return [String] - attr_accessor :error_message - - # A summary of the current patch state across all instances that this patch - # job affects. Contains counts of instances in different states. These states - # map to `InstancePatchState`. List patch job instance details to see the - # specific states of each instance. - # Corresponds to the JSON property `instanceDetailsSummary` - # @return [Google::Apis::OsconfigV1beta::PatchJobInstanceDetailsSummary] - attr_accessor :instance_details_summary - - # A filter to target VM instances for patching. The targeted - # VMs must meet all criteria specified. So if both labels and zones are - # specified, the patch job targets only VMs with those labels and in those - # zones. - # Corresponds to the JSON property `instanceFilter` - # @return [Google::Apis::OsconfigV1beta::PatchInstanceFilter] - attr_accessor :instance_filter - - # Unique identifier for this patch job in the form - # `projects/*/patchJobs/*` - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Patch configuration specifications. Contains details on how to apply the - # patch(es) to a VM instance. - # Corresponds to the JSON property `patchConfig` - # @return [Google::Apis::OsconfigV1beta::PatchConfig] - attr_accessor :patch_config - - # Output only. Name of the patch deployment that created this patch job. - # Corresponds to the JSON property `patchDeployment` - # @return [String] - attr_accessor :patch_deployment - - # Reflects the overall progress of the patch job in the range of - # 0.0 being no progress to 100.0 being complete. - # Corresponds to the JSON property `percentComplete` - # @return [Float] - attr_accessor :percent_complete - - # The current state of the PatchJob . - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - # Last time this patch job was updated. - # Corresponds to the JSON property `updateTime` - # @return [String] - attr_accessor :update_time - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @create_time = args[:create_time] if args.key?(:create_time) - @description = args[:description] if args.key?(:description) - @display_name = args[:display_name] if args.key?(:display_name) - @dry_run = args[:dry_run] if args.key?(:dry_run) - @duration = args[:duration] if args.key?(:duration) - @error_message = args[:error_message] if args.key?(:error_message) - @instance_details_summary = args[:instance_details_summary] if args.key?(:instance_details_summary) - @instance_filter = args[:instance_filter] if args.key?(:instance_filter) - @name = args[:name] if args.key?(:name) - @patch_config = args[:patch_config] if args.key?(:patch_config) - @patch_deployment = args[:patch_deployment] if args.key?(:patch_deployment) - @percent_complete = args[:percent_complete] if args.key?(:percent_complete) - @state = args[:state] if args.key?(:state) - @update_time = args[:update_time] if args.key?(:update_time) - end - end - - # Patch details for a VM instance. For more information about reviewing VM - # instance details, see - # [Listing all VM instance details for a specific patch - # job](/compute/docs/os-patch-management/manage-patch-jobs#list-instance-details) - # . - class PatchJobInstanceDetails - include Google::Apis::Core::Hashable - - # The number of times the agent that the agent attempts to apply the patch. - # Corresponds to the JSON property `attemptCount` - # @return [Fixnum] - attr_accessor :attempt_count - - # If the patch fails, this field provides the reason. - # Corresponds to the JSON property `failureReason` - # @return [String] - attr_accessor :failure_reason - - # The unique identifier for the instance. This identifier is - # defined by the server. - # Corresponds to the JSON property `instanceSystemId` - # @return [String] - attr_accessor :instance_system_id - - # The instance name in the form `projects/*/zones/*/instances/*` - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Current state of instance patch. - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @attempt_count = args[:attempt_count] if args.key?(:attempt_count) - @failure_reason = args[:failure_reason] if args.key?(:failure_reason) - @instance_system_id = args[:instance_system_id] if args.key?(:instance_system_id) - @name = args[:name] if args.key?(:name) - @state = args[:state] if args.key?(:state) - end - end - - # A summary of the current patch state across all instances that this patch - # job affects. Contains counts of instances in different states. These states - # map to `InstancePatchState`. List patch job instance details to see the - # specific states of each instance. - class PatchJobInstanceDetailsSummary - include Google::Apis::Core::Hashable - - # Number of instances that have acked and will start shortly. - # Corresponds to the JSON property `ackedInstanceCount` - # @return [Fixnum] - attr_accessor :acked_instance_count - - # Number of instances that are applying patches. - # Corresponds to the JSON property `applyingPatchesInstanceCount` - # @return [Fixnum] - attr_accessor :applying_patches_instance_count - - # Number of instances that are downloading patches. - # Corresponds to the JSON property `downloadingPatchesInstanceCount` - # @return [Fixnum] - attr_accessor :downloading_patches_instance_count - - # Number of instances that failed. - # Corresponds to the JSON property `failedInstanceCount` - # @return [Fixnum] - attr_accessor :failed_instance_count - - # Number of instances that are inactive. - # Corresponds to the JSON property `inactiveInstanceCount` - # @return [Fixnum] - attr_accessor :inactive_instance_count - - # Number of instances that do not appear to be running the agent. Check to - # ensure that the agent is installed, running, and able to communicate with - # the service. - # Corresponds to the JSON property `noAgentDetectedInstanceCount` - # @return [Fixnum] - attr_accessor :no_agent_detected_instance_count - - # Number of instances notified about patch job. - # Corresponds to the JSON property `notifiedInstanceCount` - # @return [Fixnum] - attr_accessor :notified_instance_count - - # Number of instances pending patch job. - # Corresponds to the JSON property `pendingInstanceCount` - # @return [Fixnum] - attr_accessor :pending_instance_count - - # Number of instances that are running the post-patch step. - # Corresponds to the JSON property `postPatchStepInstanceCount` - # @return [Fixnum] - attr_accessor :post_patch_step_instance_count - - # Number of instances that are running the pre-patch step. - # Corresponds to the JSON property `prePatchStepInstanceCount` - # @return [Fixnum] - attr_accessor :pre_patch_step_instance_count - - # Number of instances rebooting. - # Corresponds to the JSON property `rebootingInstanceCount` - # @return [Fixnum] - attr_accessor :rebooting_instance_count - - # Number of instances that have started. - # Corresponds to the JSON property `startedInstanceCount` - # @return [Fixnum] - attr_accessor :started_instance_count - - # Number of instances that have completed successfully. - # Corresponds to the JSON property `succeededInstanceCount` - # @return [Fixnum] - attr_accessor :succeeded_instance_count - - # Number of instances that require reboot. - # Corresponds to the JSON property `succeededRebootRequiredInstanceCount` - # @return [Fixnum] - attr_accessor :succeeded_reboot_required_instance_count - - # Number of instances that exceeded the time out while applying the patch. - # Corresponds to the JSON property `timedOutInstanceCount` - # @return [Fixnum] - attr_accessor :timed_out_instance_count - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @acked_instance_count = args[:acked_instance_count] if args.key?(:acked_instance_count) - @applying_patches_instance_count = args[:applying_patches_instance_count] if args.key?(:applying_patches_instance_count) - @downloading_patches_instance_count = args[:downloading_patches_instance_count] if args.key?(:downloading_patches_instance_count) - @failed_instance_count = args[:failed_instance_count] if args.key?(:failed_instance_count) - @inactive_instance_count = args[:inactive_instance_count] if args.key?(:inactive_instance_count) - @no_agent_detected_instance_count = args[:no_agent_detected_instance_count] if args.key?(:no_agent_detected_instance_count) - @notified_instance_count = args[:notified_instance_count] if args.key?(:notified_instance_count) - @pending_instance_count = args[:pending_instance_count] if args.key?(:pending_instance_count) - @post_patch_step_instance_count = args[:post_patch_step_instance_count] if args.key?(:post_patch_step_instance_count) - @pre_patch_step_instance_count = args[:pre_patch_step_instance_count] if args.key?(:pre_patch_step_instance_count) - @rebooting_instance_count = args[:rebooting_instance_count] if args.key?(:rebooting_instance_count) - @started_instance_count = args[:started_instance_count] if args.key?(:started_instance_count) - @succeeded_instance_count = args[:succeeded_instance_count] if args.key?(:succeeded_instance_count) - @succeeded_reboot_required_instance_count = args[:succeeded_reboot_required_instance_count] if args.key?(:succeeded_reboot_required_instance_count) - @timed_out_instance_count = args[:timed_out_instance_count] if args.key?(:timed_out_instance_count) - end - end - - # Sets the time for recurring patch deployments. - class RecurringSchedule - include Google::Apis::Core::Hashable - - # Optional. The end time at which a recurring patch deployment schedule is no - # longer - # active. - # Corresponds to the JSON property `endTime` - # @return [String] - attr_accessor :end_time - - # Required. The frequency unit of this recurring schedule. - # Corresponds to the JSON property `frequency` - # @return [String] - attr_accessor :frequency - - # Output only. The time the last patch job ran successfully. - # Corresponds to the JSON property `lastExecuteTime` - # @return [String] - attr_accessor :last_execute_time - - # Represents a monthly schedule. An example of a valid monthly schedule is - # "on the third Tuesday of the month" or "on the 15th of the month". - # Corresponds to the JSON property `monthly` - # @return [Google::Apis::OsconfigV1beta::MonthlySchedule] - attr_accessor :monthly - - # Output only. The time the next patch job is scheduled to run. - # Corresponds to the JSON property `nextExecuteTime` - # @return [String] - attr_accessor :next_execute_time - - # Optional. The time that the recurring schedule becomes effective. - # Defaults to `create_time` of the patch deployment. - # Corresponds to the JSON property `startTime` - # @return [String] - attr_accessor :start_time - - # Represents a time of day. The date and time zone are either not significant - # or are specified elsewhere. An API may choose to allow leap seconds. Related - # types are google.type.Date and `google.protobuf.Timestamp`. - # Corresponds to the JSON property `timeOfDay` - # @return [Google::Apis::OsconfigV1beta::TimeOfDay] - attr_accessor :time_of_day - - # Represents a time zone from the - # [IANA Time Zone Database](https://www.iana.org/time-zones). - # Corresponds to the JSON property `timeZone` - # @return [Google::Apis::OsconfigV1beta::TimeZone] - attr_accessor :time_zone - - # Represents a weekly schedule. - # Corresponds to the JSON property `weekly` - # @return [Google::Apis::OsconfigV1beta::WeeklySchedule] - attr_accessor :weekly - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @end_time = args[:end_time] if args.key?(:end_time) - @frequency = args[:frequency] if args.key?(:frequency) - @last_execute_time = args[:last_execute_time] if args.key?(:last_execute_time) - @monthly = args[:monthly] if args.key?(:monthly) - @next_execute_time = args[:next_execute_time] if args.key?(:next_execute_time) - @start_time = args[:start_time] if args.key?(:start_time) - @time_of_day = args[:time_of_day] if args.key?(:time_of_day) - @time_zone = args[:time_zone] if args.key?(:time_zone) - @weekly = args[:weekly] if args.key?(:weekly) - end - end - - # A software recipe is a set of instructions for installing and configuring a - # piece of software. It consists of a set of artifacts that are - # downloaded, and a set of steps that install, configure, and/or update the - # software. - # Recipes support installing and updating software from artifacts in the - # following formats: - # Zip archive, Tar archive, Windows MSI, Debian package, and RPM package. - # Additionally, recipes support executing a script (either defined in a file or - # directly in this api) in bash, sh, cmd, and powershell. - # Updating a software recipe - # If a recipe is assigned to an instance and there is a recipe with the same - # name but a lower version already installed and the assigned state - # of the recipe is `INSTALLED_KEEP_UPDATED`, then the recipe is updated to - # the new version. - # Script Working Directories - # Each script or execution step is run in its own temporary directory which - # is deleted after completing the step. - class SoftwareRecipe - include Google::Apis::Core::Hashable - - # Resources available to be used in the steps in the recipe. - # Corresponds to the JSON property `artifacts` - # @return [Array] - attr_accessor :artifacts - - # Default is INSTALLED. The desired state the agent should maintain for this - # recipe. - # INSTALLED: The software recipe is installed on the instance but - # won't be updated to new versions. - # INSTALLED_KEEP_UPDATED: The software recipe is installed on the - # instance. The recipe is updated to a higher - # version, if a higher version of the recipe is - # assigned to this instance. - # REMOVE: Remove is unsupported for software recipes and attempts to - # create or update a recipe to the REMOVE state is rejected. - # Corresponds to the JSON property `desiredState` - # @return [String] - attr_accessor :desired_state - - # Actions to be taken for installing this recipe. On failure it stops - # executing steps and does not attempt another installation. Any steps taken - # (including partially completed steps) are not rolled back. - # Corresponds to the JSON property `installSteps` - # @return [Array] - attr_accessor :install_steps - - # Required. Unique identifier for the recipe. Only one recipe with a given name - # is - # installed on an instance. - # Names are also used to identify resources which helps to determine whether - # guest policies have conflicts. This means that requests to create multiple - # recipes with the same name and version are rejected since they - # could potentially have conflicting assignments. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Actions to be taken for updating this recipe. On failure it stops - # executing steps and does not attempt another update for this recipe. Any - # steps taken (including partially completed steps) are not rolled back. - # Corresponds to the JSON property `updateSteps` - # @return [Array] - attr_accessor :update_steps - - # The version of this software recipe. Version can be up to 4 period - # separated numbers (e.g. 12.34.56.78). - # Corresponds to the JSON property `version` - # @return [String] - attr_accessor :version - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @artifacts = args[:artifacts] if args.key?(:artifacts) - @desired_state = args[:desired_state] if args.key?(:desired_state) - @install_steps = args[:install_steps] if args.key?(:install_steps) - @name = args[:name] if args.key?(:name) - @update_steps = args[:update_steps] if args.key?(:update_steps) - @version = args[:version] if args.key?(:version) - end - end - - # Specifies a resource to be used in the recipe. - class SoftwareRecipeArtifact - include Google::Apis::Core::Hashable - - # Defaults to false. When false, recipes are subject to validations - # based on the artifact type: - # Remote: A checksum must be specified, and only protocols with - # transport-layer security are permitted. - # GCS: An object generation number must be specified. - # Corresponds to the JSON property `allowInsecure` - # @return [Boolean] - attr_accessor :allow_insecure - alias_method :allow_insecure?, :allow_insecure - - # Specifies an artifact available as a Google Cloud Storage object. - # Corresponds to the JSON property `gcs` - # @return [Google::Apis::OsconfigV1beta::SoftwareRecipeArtifactGcs] - attr_accessor :gcs - - # Required. Id of the artifact, which the installation and update steps of this - # recipe can reference. Artifacts in a recipe cannot have the same id. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # Specifies an artifact available via some URI. - # Corresponds to the JSON property `remote` - # @return [Google::Apis::OsconfigV1beta::SoftwareRecipeArtifactRemote] - attr_accessor :remote - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @allow_insecure = args[:allow_insecure] if args.key?(:allow_insecure) - @gcs = args[:gcs] if args.key?(:gcs) - @id = args[:id] if args.key?(:id) - @remote = args[:remote] if args.key?(:remote) - end - end - - # Specifies an artifact available as a Google Cloud Storage object. - class SoftwareRecipeArtifactGcs - include Google::Apis::Core::Hashable - - # Bucket of the Google Cloud Storage object. - # Given an example URL: - # `https://storage.googleapis.com/my-bucket/foo/bar#1234567` - # this value would be `my-bucket`. - # Corresponds to the JSON property `bucket` - # @return [String] - attr_accessor :bucket - - # Must be provided if allow_insecure is false. - # Generation number of the Google Cloud Storage object. - # `https://storage.googleapis.com/my-bucket/foo/bar#1234567` - # this value would be `1234567`. - # Corresponds to the JSON property `generation` - # @return [Fixnum] - attr_accessor :generation - - # Name of the Google Cloud Storage object. - # As specified [here] - # (https://cloud.google.com/storage/docs/naming#objectnames) - # Given an example URL: - # `https://storage.googleapis.com/my-bucket/foo/bar#1234567` - # this value would be `foo/bar`. - # Corresponds to the JSON property `object` - # @return [String] - attr_accessor :object - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @bucket = args[:bucket] if args.key?(:bucket) - @generation = args[:generation] if args.key?(:generation) - @object = args[:object] if args.key?(:object) - end - end - - # Specifies an artifact available via some URI. - class SoftwareRecipeArtifactRemote - include Google::Apis::Core::Hashable - - # Must be provided if `allow_insecure` is `false`. - # SHA256 checksum in hex format, to compare to the checksum of the - # artifact. If the checksum is not empty and it doesn't match the - # artifact then the recipe installation fails before running any of the - # steps. - # Corresponds to the JSON property `checksum` - # @return [String] - attr_accessor :checksum - - # URI from which to fetch the object. It should contain both the protocol - # and path following the format `protocol`://`location`. - # Corresponds to the JSON property `uri` - # @return [String] - attr_accessor :uri - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @checksum = args[:checksum] if args.key?(:checksum) - @uri = args[:uri] if args.key?(:uri) - end - end - - # An action that can be taken as part of installing or updating a recipe. - class SoftwareRecipeStep - include Google::Apis::Core::Hashable - - # Extracts an archive of the type specified in the specified directory. - # Corresponds to the JSON property `archiveExtraction` - # @return [Google::Apis::OsconfigV1beta::SoftwareRecipeStepExtractArchive] - attr_accessor :archive_extraction - - # Installs a deb via dpkg. - # Corresponds to the JSON property `dpkgInstallation` - # @return [Google::Apis::OsconfigV1beta::SoftwareRecipeStepInstallDpkg] - attr_accessor :dpkg_installation - - # Copies the artifact to the specified path on the instance. - # Corresponds to the JSON property `fileCopy` - # @return [Google::Apis::OsconfigV1beta::SoftwareRecipeStepCopyFile] - attr_accessor :file_copy - - # Executes an artifact or local file. - # Corresponds to the JSON property `fileExec` - # @return [Google::Apis::OsconfigV1beta::SoftwareRecipeStepExecFile] - attr_accessor :file_exec - - # Installs an MSI file. - # Corresponds to the JSON property `msiInstallation` - # @return [Google::Apis::OsconfigV1beta::SoftwareRecipeStepInstallMsi] - attr_accessor :msi_installation - - # Installs an rpm file via the rpm utility. - # Corresponds to the JSON property `rpmInstallation` - # @return [Google::Apis::OsconfigV1beta::SoftwareRecipeStepInstallRpm] - attr_accessor :rpm_installation - - # Runs a script through an interpreter. - # Corresponds to the JSON property `scriptRun` - # @return [Google::Apis::OsconfigV1beta::SoftwareRecipeStepRunScript] - attr_accessor :script_run - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @archive_extraction = args[:archive_extraction] if args.key?(:archive_extraction) - @dpkg_installation = args[:dpkg_installation] if args.key?(:dpkg_installation) - @file_copy = args[:file_copy] if args.key?(:file_copy) - @file_exec = args[:file_exec] if args.key?(:file_exec) - @msi_installation = args[:msi_installation] if args.key?(:msi_installation) - @rpm_installation = args[:rpm_installation] if args.key?(:rpm_installation) - @script_run = args[:script_run] if args.key?(:script_run) - end - end - - # Copies the artifact to the specified path on the instance. - class SoftwareRecipeStepCopyFile - include Google::Apis::Core::Hashable - - # Required. The id of the relevant artifact in the recipe. - # Corresponds to the JSON property `artifactId` - # @return [String] - attr_accessor :artifact_id - - # Required. The absolute path on the instance to put the file. - # Corresponds to the JSON property `destination` - # @return [String] - attr_accessor :destination - - # Whether to allow this step to overwrite existing files. If this is - # false and the file already exists the file is not overwritten - # and the step is considered a success. Defaults to false. - # Corresponds to the JSON property `overwrite` - # @return [Boolean] - attr_accessor :overwrite - alias_method :overwrite?, :overwrite - - # Consists of three octal digits which represent, in - # order, the permissions of the owner, group, and other users for the - # file (similarly to the numeric mode used in the linux chmod utility). - # Each digit represents a three bit number with the 4 bit - # corresponding to the read permissions, the 2 bit corresponds to the - # write bit, and the one bit corresponds to the execute permission. - # Default behavior is 755. - # Below are some examples of permissions and their associated values: - # read, write, and execute: 7 - # read and execute: 5 - # read and write: 6 - # read only: 4 - # Corresponds to the JSON property `permissions` - # @return [String] - attr_accessor :permissions - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @artifact_id = args[:artifact_id] if args.key?(:artifact_id) - @destination = args[:destination] if args.key?(:destination) - @overwrite = args[:overwrite] if args.key?(:overwrite) - @permissions = args[:permissions] if args.key?(:permissions) - end - end - - # Executes an artifact or local file. - class SoftwareRecipeStepExecFile - include Google::Apis::Core::Hashable - - # Defaults to [0]. A list of possible return values that the program - # can return to indicate a success. - # Corresponds to the JSON property `allowedExitCodes` - # @return [Array] - attr_accessor :allowed_exit_codes - - # Arguments to be passed to the provided executable. - # Corresponds to the JSON property `args` - # @return [Array] - attr_accessor :args - - # The id of the relevant artifact in the recipe. - # Corresponds to the JSON property `artifactId` - # @return [String] - attr_accessor :artifact_id - - # The absolute path of the file on the local filesystem. - # Corresponds to the JSON property `localPath` - # @return [String] - attr_accessor :local_path - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @allowed_exit_codes = args[:allowed_exit_codes] if args.key?(:allowed_exit_codes) - @args = args[:args] if args.key?(:args) - @artifact_id = args[:artifact_id] if args.key?(:artifact_id) - @local_path = args[:local_path] if args.key?(:local_path) - end - end - - # Extracts an archive of the type specified in the specified directory. - class SoftwareRecipeStepExtractArchive - include Google::Apis::Core::Hashable - - # Required. The id of the relevant artifact in the recipe. - # Corresponds to the JSON property `artifactId` - # @return [String] - attr_accessor :artifact_id - - # Directory to extract archive to. - # Defaults to `/` on Linux or `C:\` on Windows. - # Corresponds to the JSON property `destination` - # @return [String] - attr_accessor :destination - - # Required. The type of the archive to extract. - # 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) - @artifact_id = args[:artifact_id] if args.key?(:artifact_id) - @destination = args[:destination] if args.key?(:destination) - @type = args[:type] if args.key?(:type) - end - end - - # Installs a deb via dpkg. - class SoftwareRecipeStepInstallDpkg - include Google::Apis::Core::Hashable - - # Required. The id of the relevant artifact in the recipe. - # Corresponds to the JSON property `artifactId` - # @return [String] - attr_accessor :artifact_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @artifact_id = args[:artifact_id] if args.key?(:artifact_id) - end - end - - # Installs an MSI file. - class SoftwareRecipeStepInstallMsi - include Google::Apis::Core::Hashable - - # Return codes that indicate that the software installed or updated - # successfully. Behaviour defaults to [0] - # Corresponds to the JSON property `allowedExitCodes` - # @return [Array] - attr_accessor :allowed_exit_codes - - # Required. The id of the relevant artifact in the recipe. - # Corresponds to the JSON property `artifactId` - # @return [String] - attr_accessor :artifact_id - - # The flags to use when installing the MSI - # defaults to ["/i"] (i.e. the install flag). - # Corresponds to the JSON property `flags` - # @return [Array] - attr_accessor :flags - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @allowed_exit_codes = args[:allowed_exit_codes] if args.key?(:allowed_exit_codes) - @artifact_id = args[:artifact_id] if args.key?(:artifact_id) - @flags = args[:flags] if args.key?(:flags) - end - end - - # Installs an rpm file via the rpm utility. - class SoftwareRecipeStepInstallRpm - include Google::Apis::Core::Hashable - - # Required. The id of the relevant artifact in the recipe. - # Corresponds to the JSON property `artifactId` - # @return [String] - attr_accessor :artifact_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @artifact_id = args[:artifact_id] if args.key?(:artifact_id) - end - end - - # Runs a script through an interpreter. - class SoftwareRecipeStepRunScript - include Google::Apis::Core::Hashable - - # Return codes that indicate that the software installed or updated - # successfully. Behaviour defaults to [0] - # Corresponds to the JSON property `allowedExitCodes` - # @return [Array] - attr_accessor :allowed_exit_codes - - # The script interpreter to use to run the script. If no interpreter is - # specified the script is executed directly, which likely - # only succeed for scripts with - # [shebang lines](https://en.wikipedia.org/wiki/Shebang_\(Unix\)). - # Corresponds to the JSON property `interpreter` - # @return [String] - attr_accessor :interpreter - - # Required. The shell script to be executed. - # Corresponds to the JSON property `script` - # @return [String] - attr_accessor :script - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @allowed_exit_codes = args[:allowed_exit_codes] if args.key?(:allowed_exit_codes) - @interpreter = args[:interpreter] if args.key?(:interpreter) - @script = args[:script] if args.key?(:script) - end - end - - # Represents a time of day. The date and time zone are either not significant - # or are specified elsewhere. An API may choose to allow leap seconds. Related - # types are google.type.Date and `google.protobuf.Timestamp`. - class TimeOfDay - include Google::Apis::Core::Hashable - - # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose - # to allow the value "24:00:00" for scenarios like business closing time. - # Corresponds to the JSON property `hours` - # @return [Fixnum] - attr_accessor :hours - - # Minutes of hour of day. Must be from 0 to 59. - # Corresponds to the JSON property `minutes` - # @return [Fixnum] - attr_accessor :minutes - - # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - # Corresponds to the JSON property `nanos` - # @return [Fixnum] - attr_accessor :nanos - - # Seconds of minutes of the time. Must normally be from 0 to 59. An API may - # allow the value 60 if it allows leap-seconds. - # Corresponds to the JSON property `seconds` - # @return [Fixnum] - attr_accessor :seconds - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @hours = args[:hours] if args.key?(:hours) - @minutes = args[:minutes] if args.key?(:minutes) - @nanos = args[:nanos] if args.key?(:nanos) - @seconds = args[:seconds] if args.key?(:seconds) - end - end - - # Represents a time zone from the - # [IANA Time Zone Database](https://www.iana.org/time-zones). - class TimeZone - include Google::Apis::Core::Hashable - - # IANA Time Zone Database time zone, e.g. "America/New_York". - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # Optional. IANA Time Zone Database version number, e.g. "2019a". - # Corresponds to the JSON property `version` - # @return [String] - attr_accessor :version - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @id = args[:id] if args.key?(:id) - @version = args[:version] if args.key?(:version) - end - end - - # Represents one week day in a month. An example is "the 4th Sunday". - class WeekDayOfMonth - include Google::Apis::Core::Hashable - - # Required. A day of the week. - # Corresponds to the JSON property `dayOfWeek` - # @return [String] - attr_accessor :day_of_week - - # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the - # month. -1 - # indicates the last week of the month. - # Corresponds to the JSON property `weekOrdinal` - # @return [Fixnum] - attr_accessor :week_ordinal - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @day_of_week = args[:day_of_week] if args.key?(:day_of_week) - @week_ordinal = args[:week_ordinal] if args.key?(:week_ordinal) - end - end - - # Represents a weekly schedule. - class WeeklySchedule - include Google::Apis::Core::Hashable - - # Required. Day of the week. - # Corresponds to the JSON property `dayOfWeek` - # @return [String] - attr_accessor :day_of_week - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @day_of_week = args[:day_of_week] if args.key?(:day_of_week) - end - end - - # Windows patching is performed using the Windows Update Agent. - class WindowsUpdateSettings - include Google::Apis::Core::Hashable - - # Only apply updates of these windows update classifications. If empty, all - # updates are applied. - # Corresponds to the JSON property `classifications` - # @return [Array] - attr_accessor :classifications - - # List of KBs to exclude from update. - # Corresponds to the JSON property `excludes` - # @return [Array] - attr_accessor :excludes - - # An exclusive list of kbs to be updated. These are the only patches - # that will be updated. This field must not be used with other - # patch configurations. - # Corresponds to the JSON property `exclusivePatches` - # @return [Array] - attr_accessor :exclusive_patches - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @classifications = args[:classifications] if args.key?(:classifications) - @excludes = args[:excludes] if args.key?(:excludes) - @exclusive_patches = args[:exclusive_patches] if args.key?(:exclusive_patches) - end - end - - # Represents a single Yum package repository. This repository is added to a - # repo file that is stored at `/etc/yum.repos.d/google_osconfig.repo`. - class YumRepository - include Google::Apis::Core::Hashable - - # Required. The location of the repository directory. - # Corresponds to the JSON property `baseUrl` - # @return [String] - attr_accessor :base_url - - # The display name of the repository. - # Corresponds to the JSON property `displayName` - # @return [String] - attr_accessor :display_name - - # URIs of GPG keys. - # Corresponds to the JSON property `gpgKeys` - # @return [Array] - attr_accessor :gpg_keys - - # Required. A one word, unique name for this repository. This is - # the `repo id` in the Yum config file and also the `display_name` if - # `display_name` is omitted. This id is also used as the unique identifier - # when checking for guest policy conflicts. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @base_url = args[:base_url] if args.key?(:base_url) - @display_name = args[:display_name] if args.key?(:display_name) - @gpg_keys = args[:gpg_keys] if args.key?(:gpg_keys) - @id = args[:id] if args.key?(:id) - end - end - - # Yum patching is performed by executing `yum update`. Additional options - # can be set to control how this is executed. - # Note that not all settings are supported on all platforms. - class YumSettings - include Google::Apis::Core::Hashable - - # List of packages to exclude from update. These packages are excluded by - # using the yum `--exclude` flag. - # Corresponds to the JSON property `excludes` - # @return [Array] - attr_accessor :excludes - - # An exclusive list of packages to be updated. These are the only packages - # that will be updated. If these packages are not installed, they will be - # ignored. This field must not be specified with any other patch - # configuration fields. - # Corresponds to the JSON property `exclusivePackages` - # @return [Array] - attr_accessor :exclusive_packages - - # Will cause patch to run `yum update-minimal` instead. - # Corresponds to the JSON property `minimal` - # @return [Boolean] - attr_accessor :minimal - alias_method :minimal?, :minimal - - # Adds the `--security` flag to `yum update`. Not supported on - # all platforms. - # Corresponds to the JSON property `security` - # @return [Boolean] - attr_accessor :security - alias_method :security?, :security - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @excludes = args[:excludes] if args.key?(:excludes) - @exclusive_packages = args[:exclusive_packages] if args.key?(:exclusive_packages) - @minimal = args[:minimal] if args.key?(:minimal) - @security = args[:security] if args.key?(:security) - end - end - - # Represents a single Zypper package repository. This repository is added to a - # repo file that is stored at `/etc/zypp/repos.d/google_osconfig.repo`. - class ZypperRepository - include Google::Apis::Core::Hashable - - # Required. The location of the repository directory. - # Corresponds to the JSON property `baseUrl` - # @return [String] - attr_accessor :base_url - - # The display name of the repository. - # Corresponds to the JSON property `displayName` - # @return [String] - attr_accessor :display_name - - # URIs of GPG keys. - # Corresponds to the JSON property `gpgKeys` - # @return [Array] - attr_accessor :gpg_keys - - # Required. A one word, unique name for this repository. This is - # the `repo id` in the zypper config file and also the `display_name` if - # `display_name` is omitted. This id is also used as the unique identifier - # when checking for guest policy conflicts. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @base_url = args[:base_url] if args.key?(:base_url) - @display_name = args[:display_name] if args.key?(:display_name) - @gpg_keys = args[:gpg_keys] if args.key?(:gpg_keys) - @id = args[:id] if args.key?(:id) - end - end - - # Zypper patching is performed by running `zypper patch`. - # See also https://en.opensuse.org/SDB:Zypper_manual. - class ZypperSettings - include Google::Apis::Core::Hashable - - # Install only patches with these categories. - # Common categories include security, recommended, and feature. - # Corresponds to the JSON property `categories` - # @return [Array] - attr_accessor :categories - - # List of patches to exclude from update. - # Corresponds to the JSON property `excludes` - # @return [Array] - attr_accessor :excludes - - # An exclusive list of patches to be updated. These are the only patches - # that will be installed using 'zypper patch patch:' command. - # This field must not be used with any other patch configuration fields. - # Corresponds to the JSON property `exclusivePatches` - # @return [Array] - attr_accessor :exclusive_patches - - # Install only patches with these severities. - # Common severities include critical, important, moderate, and low. - # Corresponds to the JSON property `severities` - # @return [Array] - attr_accessor :severities - - # Adds the `--with-optional` flag to `zypper patch`. - # Corresponds to the JSON property `withOptional` - # @return [Boolean] - attr_accessor :with_optional - alias_method :with_optional?, :with_optional - - # Adds the `--with-update` flag, to `zypper patch`. - # Corresponds to the JSON property `withUpdate` - # @return [Boolean] - attr_accessor :with_update - alias_method :with_update?, :with_update - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @categories = args[:categories] if args.key?(:categories) - @excludes = args[:excludes] if args.key?(:excludes) - @exclusive_patches = args[:exclusive_patches] if args.key?(:exclusive_patches) - @severities = args[:severities] if args.key?(:severities) - @with_optional = args[:with_optional] if args.key?(:with_optional) - @with_update = args[:with_update] if args.key?(:with_update) - end - end - end - end -end diff --git a/generated/google/apis/osconfig_v1beta/representations.rb b/generated/google/apis/osconfig_v1beta/representations.rb deleted file mode 100644 index 426bf7efc..000000000 --- a/generated/google/apis/osconfig_v1beta/representations.rb +++ /dev/null @@ -1,966 +0,0 @@ -# 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 OsconfigV1beta - - class AptRepository - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AptSettings - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Assignment - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AssignmentGroupLabel - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AssignmentOsType - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class CancelPatchJobRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class EffectiveGuestPolicy - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class EffectiveGuestPolicySourcedPackage - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class EffectiveGuestPolicySourcedPackageRepository - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class EffectiveGuestPolicySourcedSoftwareRecipe - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Empty - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ExecStep - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ExecStepConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ExecutePatchJobRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GcsObject - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GooRepository - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GooSettings - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GuestPolicy - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListGuestPoliciesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListPatchDeploymentsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListPatchJobInstanceDetailsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListPatchJobsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class LookupEffectiveGuestPolicyRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class MonthlySchedule - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OneTimeSchedule - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Package - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PackageRepository - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PatchConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PatchDeployment - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PatchInstanceFilter - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PatchInstanceFilterGroupLabel - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PatchJob - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PatchJobInstanceDetails - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PatchJobInstanceDetailsSummary - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RecurringSchedule - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SoftwareRecipe - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SoftwareRecipeArtifact - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SoftwareRecipeArtifactGcs - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SoftwareRecipeArtifactRemote - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SoftwareRecipeStep - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SoftwareRecipeStepCopyFile - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SoftwareRecipeStepExecFile - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SoftwareRecipeStepExtractArchive - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SoftwareRecipeStepInstallDpkg - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SoftwareRecipeStepInstallMsi - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SoftwareRecipeStepInstallRpm - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SoftwareRecipeStepRunScript - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TimeOfDay - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TimeZone - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class WeekDayOfMonth - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class WeeklySchedule - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class WindowsUpdateSettings - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class YumRepository - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class YumSettings - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ZypperRepository - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ZypperSettings - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AptRepository - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :archive_type, as: 'archiveType' - collection :components, as: 'components' - property :distribution, as: 'distribution' - property :gpg_key, as: 'gpgKey' - property :uri, as: 'uri' - end - end - - class AptSettings - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :excludes, as: 'excludes' - collection :exclusive_packages, as: 'exclusivePackages' - property :type, as: 'type' - end - end - - class Assignment - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :group_labels, as: 'groupLabels', class: Google::Apis::OsconfigV1beta::AssignmentGroupLabel, decorator: Google::Apis::OsconfigV1beta::AssignmentGroupLabel::Representation - - collection :instance_name_prefixes, as: 'instanceNamePrefixes' - collection :instances, as: 'instances' - collection :os_types, as: 'osTypes', class: Google::Apis::OsconfigV1beta::AssignmentOsType, decorator: Google::Apis::OsconfigV1beta::AssignmentOsType::Representation - - collection :zones, as: 'zones' - end - end - - class AssignmentGroupLabel - # @private - class Representation < Google::Apis::Core::JsonRepresentation - hash :labels, as: 'labels' - end - end - - class AssignmentOsType - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :os_architecture, as: 'osArchitecture' - property :os_short_name, as: 'osShortName' - property :os_version, as: 'osVersion' - end - end - - class CancelPatchJobRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - end - end - - class EffectiveGuestPolicy - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :package_repositories, as: 'packageRepositories', class: Google::Apis::OsconfigV1beta::EffectiveGuestPolicySourcedPackageRepository, decorator: Google::Apis::OsconfigV1beta::EffectiveGuestPolicySourcedPackageRepository::Representation - - collection :packages, as: 'packages', class: Google::Apis::OsconfigV1beta::EffectiveGuestPolicySourcedPackage, decorator: Google::Apis::OsconfigV1beta::EffectiveGuestPolicySourcedPackage::Representation - - collection :software_recipes, as: 'softwareRecipes', class: Google::Apis::OsconfigV1beta::EffectiveGuestPolicySourcedSoftwareRecipe, decorator: Google::Apis::OsconfigV1beta::EffectiveGuestPolicySourcedSoftwareRecipe::Representation - - end - end - - class EffectiveGuestPolicySourcedPackage - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :package, as: 'package', class: Google::Apis::OsconfigV1beta::Package, decorator: Google::Apis::OsconfigV1beta::Package::Representation - - property :source, as: 'source' - end - end - - class EffectiveGuestPolicySourcedPackageRepository - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :package_repository, as: 'packageRepository', class: Google::Apis::OsconfigV1beta::PackageRepository, decorator: Google::Apis::OsconfigV1beta::PackageRepository::Representation - - property :source, as: 'source' - end - end - - class EffectiveGuestPolicySourcedSoftwareRecipe - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :software_recipe, as: 'softwareRecipe', class: Google::Apis::OsconfigV1beta::SoftwareRecipe, decorator: Google::Apis::OsconfigV1beta::SoftwareRecipe::Representation - - property :source, as: 'source' - end - end - - class Empty - # @private - class Representation < Google::Apis::Core::JsonRepresentation - end - end - - class ExecStep - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :linux_exec_step_config, as: 'linuxExecStepConfig', class: Google::Apis::OsconfigV1beta::ExecStepConfig, decorator: Google::Apis::OsconfigV1beta::ExecStepConfig::Representation - - property :windows_exec_step_config, as: 'windowsExecStepConfig', class: Google::Apis::OsconfigV1beta::ExecStepConfig, decorator: Google::Apis::OsconfigV1beta::ExecStepConfig::Representation - - end - end - - class ExecStepConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :allowed_success_codes, as: 'allowedSuccessCodes' - property :gcs_object, as: 'gcsObject', class: Google::Apis::OsconfigV1beta::GcsObject, decorator: Google::Apis::OsconfigV1beta::GcsObject::Representation - - property :interpreter, as: 'interpreter' - property :local_path, as: 'localPath' - end - end - - class ExecutePatchJobRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :description, as: 'description' - property :display_name, as: 'displayName' - property :dry_run, as: 'dryRun' - property :duration, as: 'duration' - property :instance_filter, as: 'instanceFilter', class: Google::Apis::OsconfigV1beta::PatchInstanceFilter, decorator: Google::Apis::OsconfigV1beta::PatchInstanceFilter::Representation - - property :patch_config, as: 'patchConfig', class: Google::Apis::OsconfigV1beta::PatchConfig, decorator: Google::Apis::OsconfigV1beta::PatchConfig::Representation - - end - end - - class GcsObject - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :bucket, as: 'bucket' - property :generation_number, :numeric_string => true, as: 'generationNumber' - property :object, as: 'object' - end - end - - class GooRepository - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :name, as: 'name' - property :url, as: 'url' - end - end - - class GooSettings - # @private - class Representation < Google::Apis::Core::JsonRepresentation - end - end - - class GuestPolicy - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :assignment, as: 'assignment', class: Google::Apis::OsconfigV1beta::Assignment, decorator: Google::Apis::OsconfigV1beta::Assignment::Representation - - property :create_time, as: 'createTime' - property :description, as: 'description' - property :etag, as: 'etag' - property :name, as: 'name' - collection :package_repositories, as: 'packageRepositories', class: Google::Apis::OsconfigV1beta::PackageRepository, decorator: Google::Apis::OsconfigV1beta::PackageRepository::Representation - - collection :packages, as: 'packages', class: Google::Apis::OsconfigV1beta::Package, decorator: Google::Apis::OsconfigV1beta::Package::Representation - - collection :recipes, as: 'recipes', class: Google::Apis::OsconfigV1beta::SoftwareRecipe, decorator: Google::Apis::OsconfigV1beta::SoftwareRecipe::Representation - - property :update_time, as: 'updateTime' - end - end - - class ListGuestPoliciesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :guest_policies, as: 'guestPolicies', class: Google::Apis::OsconfigV1beta::GuestPolicy, decorator: Google::Apis::OsconfigV1beta::GuestPolicy::Representation - - property :next_page_token, as: 'nextPageToken' - end - end - - class ListPatchDeploymentsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :patch_deployments, as: 'patchDeployments', class: Google::Apis::OsconfigV1beta::PatchDeployment, decorator: Google::Apis::OsconfigV1beta::PatchDeployment::Representation - - end - end - - class ListPatchJobInstanceDetailsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :patch_job_instance_details, as: 'patchJobInstanceDetails', class: Google::Apis::OsconfigV1beta::PatchJobInstanceDetails, decorator: Google::Apis::OsconfigV1beta::PatchJobInstanceDetails::Representation - - end - end - - class ListPatchJobsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :patch_jobs, as: 'patchJobs', class: Google::Apis::OsconfigV1beta::PatchJob, decorator: Google::Apis::OsconfigV1beta::PatchJob::Representation - - end - end - - class LookupEffectiveGuestPolicyRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :os_architecture, as: 'osArchitecture' - property :os_short_name, as: 'osShortName' - property :os_version, as: 'osVersion' - end - end - - class MonthlySchedule - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :month_day, as: 'monthDay' - property :week_day_of_month, as: 'weekDayOfMonth', class: Google::Apis::OsconfigV1beta::WeekDayOfMonth, decorator: Google::Apis::OsconfigV1beta::WeekDayOfMonth::Representation - - end - end - - class OneTimeSchedule - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :execute_time, as: 'executeTime' - end - end - - class Package - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :desired_state, as: 'desiredState' - property :manager, as: 'manager' - property :name, as: 'name' - end - end - - class PackageRepository - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :apt, as: 'apt', class: Google::Apis::OsconfigV1beta::AptRepository, decorator: Google::Apis::OsconfigV1beta::AptRepository::Representation - - property :goo, as: 'goo', class: Google::Apis::OsconfigV1beta::GooRepository, decorator: Google::Apis::OsconfigV1beta::GooRepository::Representation - - property :yum, as: 'yum', class: Google::Apis::OsconfigV1beta::YumRepository, decorator: Google::Apis::OsconfigV1beta::YumRepository::Representation - - property :zypper, as: 'zypper', class: Google::Apis::OsconfigV1beta::ZypperRepository, decorator: Google::Apis::OsconfigV1beta::ZypperRepository::Representation - - end - end - - class PatchConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :apt, as: 'apt', class: Google::Apis::OsconfigV1beta::AptSettings, decorator: Google::Apis::OsconfigV1beta::AptSettings::Representation - - property :goo, as: 'goo', class: Google::Apis::OsconfigV1beta::GooSettings, decorator: Google::Apis::OsconfigV1beta::GooSettings::Representation - - property :post_step, as: 'postStep', class: Google::Apis::OsconfigV1beta::ExecStep, decorator: Google::Apis::OsconfigV1beta::ExecStep::Representation - - property :pre_step, as: 'preStep', class: Google::Apis::OsconfigV1beta::ExecStep, decorator: Google::Apis::OsconfigV1beta::ExecStep::Representation - - property :reboot_config, as: 'rebootConfig' - property :windows_update, as: 'windowsUpdate', class: Google::Apis::OsconfigV1beta::WindowsUpdateSettings, decorator: Google::Apis::OsconfigV1beta::WindowsUpdateSettings::Representation - - property :yum, as: 'yum', class: Google::Apis::OsconfigV1beta::YumSettings, decorator: Google::Apis::OsconfigV1beta::YumSettings::Representation - - property :zypper, as: 'zypper', class: Google::Apis::OsconfigV1beta::ZypperSettings, decorator: Google::Apis::OsconfigV1beta::ZypperSettings::Representation - - end - end - - class PatchDeployment - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :create_time, as: 'createTime' - property :description, as: 'description' - property :duration, as: 'duration' - property :instance_filter, as: 'instanceFilter', class: Google::Apis::OsconfigV1beta::PatchInstanceFilter, decorator: Google::Apis::OsconfigV1beta::PatchInstanceFilter::Representation - - property :last_execute_time, as: 'lastExecuteTime' - property :name, as: 'name' - property :one_time_schedule, as: 'oneTimeSchedule', class: Google::Apis::OsconfigV1beta::OneTimeSchedule, decorator: Google::Apis::OsconfigV1beta::OneTimeSchedule::Representation - - property :patch_config, as: 'patchConfig', class: Google::Apis::OsconfigV1beta::PatchConfig, decorator: Google::Apis::OsconfigV1beta::PatchConfig::Representation - - property :recurring_schedule, as: 'recurringSchedule', class: Google::Apis::OsconfigV1beta::RecurringSchedule, decorator: Google::Apis::OsconfigV1beta::RecurringSchedule::Representation - - property :update_time, as: 'updateTime' - end - end - - class PatchInstanceFilter - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :all, as: 'all' - collection :group_labels, as: 'groupLabels', class: Google::Apis::OsconfigV1beta::PatchInstanceFilterGroupLabel, decorator: Google::Apis::OsconfigV1beta::PatchInstanceFilterGroupLabel::Representation - - collection :instance_name_prefixes, as: 'instanceNamePrefixes' - collection :instances, as: 'instances' - collection :zones, as: 'zones' - end - end - - class PatchInstanceFilterGroupLabel - # @private - class Representation < Google::Apis::Core::JsonRepresentation - hash :labels, as: 'labels' - end - end - - class PatchJob - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :create_time, as: 'createTime' - property :description, as: 'description' - property :display_name, as: 'displayName' - property :dry_run, as: 'dryRun' - property :duration, as: 'duration' - property :error_message, as: 'errorMessage' - property :instance_details_summary, as: 'instanceDetailsSummary', class: Google::Apis::OsconfigV1beta::PatchJobInstanceDetailsSummary, decorator: Google::Apis::OsconfigV1beta::PatchJobInstanceDetailsSummary::Representation - - property :instance_filter, as: 'instanceFilter', class: Google::Apis::OsconfigV1beta::PatchInstanceFilter, decorator: Google::Apis::OsconfigV1beta::PatchInstanceFilter::Representation - - property :name, as: 'name' - property :patch_config, as: 'patchConfig', class: Google::Apis::OsconfigV1beta::PatchConfig, decorator: Google::Apis::OsconfigV1beta::PatchConfig::Representation - - property :patch_deployment, as: 'patchDeployment' - property :percent_complete, as: 'percentComplete' - property :state, as: 'state' - property :update_time, as: 'updateTime' - end - end - - class PatchJobInstanceDetails - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :attempt_count, :numeric_string => true, as: 'attemptCount' - property :failure_reason, as: 'failureReason' - property :instance_system_id, as: 'instanceSystemId' - property :name, as: 'name' - property :state, as: 'state' - end - end - - class PatchJobInstanceDetailsSummary - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :acked_instance_count, :numeric_string => true, as: 'ackedInstanceCount' - property :applying_patches_instance_count, :numeric_string => true, as: 'applyingPatchesInstanceCount' - property :downloading_patches_instance_count, :numeric_string => true, as: 'downloadingPatchesInstanceCount' - property :failed_instance_count, :numeric_string => true, as: 'failedInstanceCount' - property :inactive_instance_count, :numeric_string => true, as: 'inactiveInstanceCount' - property :no_agent_detected_instance_count, :numeric_string => true, as: 'noAgentDetectedInstanceCount' - property :notified_instance_count, :numeric_string => true, as: 'notifiedInstanceCount' - property :pending_instance_count, :numeric_string => true, as: 'pendingInstanceCount' - property :post_patch_step_instance_count, :numeric_string => true, as: 'postPatchStepInstanceCount' - property :pre_patch_step_instance_count, :numeric_string => true, as: 'prePatchStepInstanceCount' - property :rebooting_instance_count, :numeric_string => true, as: 'rebootingInstanceCount' - property :started_instance_count, :numeric_string => true, as: 'startedInstanceCount' - property :succeeded_instance_count, :numeric_string => true, as: 'succeededInstanceCount' - property :succeeded_reboot_required_instance_count, :numeric_string => true, as: 'succeededRebootRequiredInstanceCount' - property :timed_out_instance_count, :numeric_string => true, as: 'timedOutInstanceCount' - end - end - - class RecurringSchedule - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :end_time, as: 'endTime' - property :frequency, as: 'frequency' - property :last_execute_time, as: 'lastExecuteTime' - property :monthly, as: 'monthly', class: Google::Apis::OsconfigV1beta::MonthlySchedule, decorator: Google::Apis::OsconfigV1beta::MonthlySchedule::Representation - - property :next_execute_time, as: 'nextExecuteTime' - property :start_time, as: 'startTime' - property :time_of_day, as: 'timeOfDay', class: Google::Apis::OsconfigV1beta::TimeOfDay, decorator: Google::Apis::OsconfigV1beta::TimeOfDay::Representation - - property :time_zone, as: 'timeZone', class: Google::Apis::OsconfigV1beta::TimeZone, decorator: Google::Apis::OsconfigV1beta::TimeZone::Representation - - property :weekly, as: 'weekly', class: Google::Apis::OsconfigV1beta::WeeklySchedule, decorator: Google::Apis::OsconfigV1beta::WeeklySchedule::Representation - - end - end - - class SoftwareRecipe - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :artifacts, as: 'artifacts', class: Google::Apis::OsconfigV1beta::SoftwareRecipeArtifact, decorator: Google::Apis::OsconfigV1beta::SoftwareRecipeArtifact::Representation - - property :desired_state, as: 'desiredState' - collection :install_steps, as: 'installSteps', class: Google::Apis::OsconfigV1beta::SoftwareRecipeStep, decorator: Google::Apis::OsconfigV1beta::SoftwareRecipeStep::Representation - - property :name, as: 'name' - collection :update_steps, as: 'updateSteps', class: Google::Apis::OsconfigV1beta::SoftwareRecipeStep, decorator: Google::Apis::OsconfigV1beta::SoftwareRecipeStep::Representation - - property :version, as: 'version' - end - end - - class SoftwareRecipeArtifact - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :allow_insecure, as: 'allowInsecure' - property :gcs, as: 'gcs', class: Google::Apis::OsconfigV1beta::SoftwareRecipeArtifactGcs, decorator: Google::Apis::OsconfigV1beta::SoftwareRecipeArtifactGcs::Representation - - property :id, as: 'id' - property :remote, as: 'remote', class: Google::Apis::OsconfigV1beta::SoftwareRecipeArtifactRemote, decorator: Google::Apis::OsconfigV1beta::SoftwareRecipeArtifactRemote::Representation - - end - end - - class SoftwareRecipeArtifactGcs - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :bucket, as: 'bucket' - property :generation, :numeric_string => true, as: 'generation' - property :object, as: 'object' - end - end - - class SoftwareRecipeArtifactRemote - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :checksum, as: 'checksum' - property :uri, as: 'uri' - end - end - - class SoftwareRecipeStep - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :archive_extraction, as: 'archiveExtraction', class: Google::Apis::OsconfigV1beta::SoftwareRecipeStepExtractArchive, decorator: Google::Apis::OsconfigV1beta::SoftwareRecipeStepExtractArchive::Representation - - property :dpkg_installation, as: 'dpkgInstallation', class: Google::Apis::OsconfigV1beta::SoftwareRecipeStepInstallDpkg, decorator: Google::Apis::OsconfigV1beta::SoftwareRecipeStepInstallDpkg::Representation - - property :file_copy, as: 'fileCopy', class: Google::Apis::OsconfigV1beta::SoftwareRecipeStepCopyFile, decorator: Google::Apis::OsconfigV1beta::SoftwareRecipeStepCopyFile::Representation - - property :file_exec, as: 'fileExec', class: Google::Apis::OsconfigV1beta::SoftwareRecipeStepExecFile, decorator: Google::Apis::OsconfigV1beta::SoftwareRecipeStepExecFile::Representation - - property :msi_installation, as: 'msiInstallation', class: Google::Apis::OsconfigV1beta::SoftwareRecipeStepInstallMsi, decorator: Google::Apis::OsconfigV1beta::SoftwareRecipeStepInstallMsi::Representation - - property :rpm_installation, as: 'rpmInstallation', class: Google::Apis::OsconfigV1beta::SoftwareRecipeStepInstallRpm, decorator: Google::Apis::OsconfigV1beta::SoftwareRecipeStepInstallRpm::Representation - - property :script_run, as: 'scriptRun', class: Google::Apis::OsconfigV1beta::SoftwareRecipeStepRunScript, decorator: Google::Apis::OsconfigV1beta::SoftwareRecipeStepRunScript::Representation - - end - end - - class SoftwareRecipeStepCopyFile - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :artifact_id, as: 'artifactId' - property :destination, as: 'destination' - property :overwrite, as: 'overwrite' - property :permissions, as: 'permissions' - end - end - - class SoftwareRecipeStepExecFile - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :allowed_exit_codes, as: 'allowedExitCodes' - collection :args, as: 'args' - property :artifact_id, as: 'artifactId' - property :local_path, as: 'localPath' - end - end - - class SoftwareRecipeStepExtractArchive - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :artifact_id, as: 'artifactId' - property :destination, as: 'destination' - property :type, as: 'type' - end - end - - class SoftwareRecipeStepInstallDpkg - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :artifact_id, as: 'artifactId' - end - end - - class SoftwareRecipeStepInstallMsi - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :allowed_exit_codes, as: 'allowedExitCodes' - property :artifact_id, as: 'artifactId' - collection :flags, as: 'flags' - end - end - - class SoftwareRecipeStepInstallRpm - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :artifact_id, as: 'artifactId' - end - end - - class SoftwareRecipeStepRunScript - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :allowed_exit_codes, as: 'allowedExitCodes' - property :interpreter, as: 'interpreter' - property :script, as: 'script' - end - end - - class TimeOfDay - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :hours, as: 'hours' - property :minutes, as: 'minutes' - property :nanos, as: 'nanos' - property :seconds, as: 'seconds' - end - end - - class TimeZone - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :id, as: 'id' - property :version, as: 'version' - end - end - - class WeekDayOfMonth - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :day_of_week, as: 'dayOfWeek' - property :week_ordinal, as: 'weekOrdinal' - end - end - - class WeeklySchedule - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :day_of_week, as: 'dayOfWeek' - end - end - - class WindowsUpdateSettings - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :classifications, as: 'classifications' - collection :excludes, as: 'excludes' - collection :exclusive_patches, as: 'exclusivePatches' - end - end - - class YumRepository - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :base_url, as: 'baseUrl' - property :display_name, as: 'displayName' - collection :gpg_keys, as: 'gpgKeys' - property :id, as: 'id' - end - end - - class YumSettings - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :excludes, as: 'excludes' - collection :exclusive_packages, as: 'exclusivePackages' - property :minimal, as: 'minimal' - property :security, as: 'security' - end - end - - class ZypperRepository - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :base_url, as: 'baseUrl' - property :display_name, as: 'displayName' - collection :gpg_keys, as: 'gpgKeys' - property :id, as: 'id' - end - end - - class ZypperSettings - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :categories, as: 'categories' - collection :excludes, as: 'excludes' - collection :exclusive_patches, as: 'exclusivePatches' - collection :severities, as: 'severities' - property :with_optional, as: 'withOptional' - property :with_update, as: 'withUpdate' - end - end - end - end -end diff --git a/generated/google/apis/osconfig_v1beta/service.rb b/generated/google/apis/osconfig_v1beta/service.rb deleted file mode 100644 index f299e9724..000000000 --- a/generated/google/apis/osconfig_v1beta/service.rb +++ /dev/null @@ -1,605 +0,0 @@ -# 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 '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 OsconfigV1beta - # Cloud OS Config API - # - # OS management tools that can be used for patch management, patch compliance, - # and configuration management on VM instances. - # - # @example - # require 'google/apis/osconfig_v1beta' - # - # Osconfig = Google::Apis::OsconfigV1beta # Alias the module - # service = Osconfig::SystemsManagementService.new - # - # @see https://cloud.google.com/ - class SystemsManagementService < Google::Apis::Core::BaseService - # @return [String] - # API key. Your API key identifies your project and provides you with API access, - # quota, and reports. Required unless you provide an OAuth 2.0 token. - attr_accessor :key - - # @return [String] - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - attr_accessor :quota_user - - def initialize - super('https://osconfig.googleapis.com/', '') - @batch_path = 'batch' - end - - # Create an OS Config guest policy. - # @param [String] parent - # Required. The resource name of the parent using one of the following forms: - # `projects/`project_number``. - # @param [Google::Apis::OsconfigV1beta::GuestPolicy] guest_policy_object - # @param [String] guest_policy_id - # Required. The logical name of the guest policy in the project - # with the following restrictions: - # * Must contain only lowercase letters, numbers, and hyphens. - # * Must start with a letter. - # * Must be between 1-63 characters. - # * Must end with a number or a letter. - # * Must be unique within the project. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::OsconfigV1beta::GuestPolicy] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::OsconfigV1beta::GuestPolicy] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_project_guest_policy(parent, guest_policy_object = nil, guest_policy_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta/{+parent}/guestPolicies', options) - command.request_representation = Google::Apis::OsconfigV1beta::GuestPolicy::Representation - command.request_object = guest_policy_object - command.response_representation = Google::Apis::OsconfigV1beta::GuestPolicy::Representation - command.response_class = Google::Apis::OsconfigV1beta::GuestPolicy - command.params['parent'] = parent unless parent.nil? - command.query['guestPolicyId'] = guest_policy_id unless guest_policy_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Delete an OS Config guest policy. - # @param [String] name - # Required. The resource name of the guest policy using one of the following - # forms: - # `projects/`project_number`/guestPolicies/`guest_policy_id``. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::OsconfigV1beta::Empty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::OsconfigV1beta::Empty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_project_guest_policy(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'v1beta/{+name}', options) - command.response_representation = Google::Apis::OsconfigV1beta::Empty::Representation - command.response_class = Google::Apis::OsconfigV1beta::Empty - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Get an OS Config guest policy. - # @param [String] name - # Required. The resource name of the guest policy using one of the following - # forms: - # `projects/`project_number`/guestPolicies/`guest_policy_id``. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::OsconfigV1beta::GuestPolicy] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::OsconfigV1beta::GuestPolicy] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_guest_policy(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta/{+name}', options) - command.response_representation = Google::Apis::OsconfigV1beta::GuestPolicy::Representation - command.response_class = Google::Apis::OsconfigV1beta::GuestPolicy - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Get a page of OS Config guest policies. - # @param [String] parent - # Required. The resource name of the parent using one of the following forms: - # `projects/`project_number``. - # @param [Fixnum] page_size - # The maximum number of guest policies to return. - # @param [String] page_token - # A pagination token returned from a previous call to `ListGuestPolicies` - # that indicates where this listing should continue from. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::OsconfigV1beta::ListGuestPoliciesResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::OsconfigV1beta::ListGuestPoliciesResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_guest_policies(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta/{+parent}/guestPolicies', options) - command.response_representation = Google::Apis::OsconfigV1beta::ListGuestPoliciesResponse::Representation - command.response_class = Google::Apis::OsconfigV1beta::ListGuestPoliciesResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Update an OS Config guest policy. - # @param [String] name - # Required. Unique name of the resource in this project using one of the - # following - # forms: - # `projects/`project_number`/guestPolicies/`guest_policy_id``. - # @param [Google::Apis::OsconfigV1beta::GuestPolicy] guest_policy_object - # @param [String] update_mask - # Field mask that controls which fields of the guest policy should be - # updated. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::OsconfigV1beta::GuestPolicy] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::OsconfigV1beta::GuestPolicy] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_project_guest_policy(name, guest_policy_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:patch, 'v1beta/{+name}', options) - command.request_representation = Google::Apis::OsconfigV1beta::GuestPolicy::Representation - command.request_object = guest_policy_object - command.response_representation = Google::Apis::OsconfigV1beta::GuestPolicy::Representation - command.response_class = Google::Apis::OsconfigV1beta::GuestPolicy - command.params['name'] = name unless name.nil? - command.query['updateMask'] = update_mask unless update_mask.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Create an OS Config patch deployment. - # @param [String] parent - # Required. The project to apply this patch deployment to in the form `projects/* - # `. - # @param [Google::Apis::OsconfigV1beta::PatchDeployment] patch_deployment_object - # @param [String] patch_deployment_id - # Required. A name for the patch deployment in the project. When creating a name - # the following rules apply: - # * Must contain only lowercase letters, numbers, and hyphens. - # * Must start with a letter. - # * Must be between 1-63 characters. - # * Must end with a number or a letter. - # * Must be unique within the project. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::OsconfigV1beta::PatchDeployment] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::OsconfigV1beta::PatchDeployment] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_project_patch_deployment(parent, patch_deployment_object = nil, patch_deployment_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta/{+parent}/patchDeployments', options) - command.request_representation = Google::Apis::OsconfigV1beta::PatchDeployment::Representation - command.request_object = patch_deployment_object - command.response_representation = Google::Apis::OsconfigV1beta::PatchDeployment::Representation - command.response_class = Google::Apis::OsconfigV1beta::PatchDeployment - command.params['parent'] = parent unless parent.nil? - command.query['patchDeploymentId'] = patch_deployment_id unless patch_deployment_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Delete an OS Config patch deployment. - # @param [String] name - # Required. The resource name of the patch deployment in the form - # `projects/*/patchDeployments/*`. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::OsconfigV1beta::Empty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::OsconfigV1beta::Empty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_project_patch_deployment(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'v1beta/{+name}', options) - command.response_representation = Google::Apis::OsconfigV1beta::Empty::Representation - command.response_class = Google::Apis::OsconfigV1beta::Empty - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Get an OS Config patch deployment. - # @param [String] name - # Required. The resource name of the patch deployment in the form - # `projects/*/patchDeployments/*`. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::OsconfigV1beta::PatchDeployment] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::OsconfigV1beta::PatchDeployment] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_patch_deployment(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta/{+name}', options) - command.response_representation = Google::Apis::OsconfigV1beta::PatchDeployment::Representation - command.response_class = Google::Apis::OsconfigV1beta::PatchDeployment - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Get a page of OS Config patch deployments. - # @param [String] parent - # Required. The resource name of the parent in the form `projects/*`. - # @param [Fixnum] page_size - # Optional. The maximum number of patch deployments to return. Default is 100. - # @param [String] page_token - # Optional. A pagination token returned from a previous call to - # ListPatchDeployments - # that indicates where this listing should continue from. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::OsconfigV1beta::ListPatchDeploymentsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::OsconfigV1beta::ListPatchDeploymentsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_patch_deployments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta/{+parent}/patchDeployments', options) - command.response_representation = Google::Apis::OsconfigV1beta::ListPatchDeploymentsResponse::Representation - command.response_class = Google::Apis::OsconfigV1beta::ListPatchDeploymentsResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Cancel a patch job. The patch job must be active. Canceled patch jobs - # cannot be restarted. - # @param [String] name - # Required. Name of the patch in the form `projects/*/patchJobs/*` - # @param [Google::Apis::OsconfigV1beta::CancelPatchJobRequest] cancel_patch_job_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::OsconfigV1beta::PatchJob] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::OsconfigV1beta::PatchJob] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def cancel_patch_job(name, cancel_patch_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta/{+name}:cancel', options) - command.request_representation = Google::Apis::OsconfigV1beta::CancelPatchJobRequest::Representation - command.request_object = cancel_patch_job_request_object - command.response_representation = Google::Apis::OsconfigV1beta::PatchJob::Representation - command.response_class = Google::Apis::OsconfigV1beta::PatchJob - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Patch VM instances by creating and running a patch job. - # @param [String] parent - # Required. The project in which to run this patch in the form `projects/*` - # @param [Google::Apis::OsconfigV1beta::ExecutePatchJobRequest] execute_patch_job_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::OsconfigV1beta::PatchJob] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::OsconfigV1beta::PatchJob] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def execute_patch_job(parent, execute_patch_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta/{+parent}/patchJobs:execute', options) - command.request_representation = Google::Apis::OsconfigV1beta::ExecutePatchJobRequest::Representation - command.request_object = execute_patch_job_request_object - command.response_representation = Google::Apis::OsconfigV1beta::PatchJob::Representation - command.response_class = Google::Apis::OsconfigV1beta::PatchJob - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Get the patch job. This can be used to track the progress of an - # ongoing patch job or review the details of completed jobs. - # @param [String] name - # Required. Name of the patch in the form `projects/*/patchJobs/*` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::OsconfigV1beta::PatchJob] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::OsconfigV1beta::PatchJob] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_patch_job(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta/{+name}', options) - command.response_representation = Google::Apis::OsconfigV1beta::PatchJob::Representation - command.response_class = Google::Apis::OsconfigV1beta::PatchJob - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Get a list of patch jobs. - # @param [String] parent - # Required. In the form of `projects/*` - # @param [String] filter - # If provided, this field specifies the criteria that must be met by patch - # jobs to be included in the response. - # Currently, filtering is only available on the patch_deployment field. - # @param [Fixnum] page_size - # The maximum number of instance status to return. - # @param [String] page_token - # A pagination token returned from a previous call - # that indicates where this listing should continue from. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::OsconfigV1beta::ListPatchJobsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::OsconfigV1beta::ListPatchJobsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_patch_jobs(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta/{+parent}/patchJobs', options) - command.response_representation = Google::Apis::OsconfigV1beta::ListPatchJobsResponse::Representation - command.response_class = Google::Apis::OsconfigV1beta::ListPatchJobsResponse - command.params['parent'] = parent unless parent.nil? - command.query['filter'] = filter unless filter.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Get a list of instance details for a given patch job. - # @param [String] parent - # Required. The parent for the instances are in the form of `projects/*/ - # patchJobs/*`. - # @param [String] filter - # A filter expression that filters results listed in the response. This - # field supports filtering results by instance zone, name, state, or - # `failure_reason`. - # @param [Fixnum] page_size - # The maximum number of instance details records to return. Default is 100. - # @param [String] page_token - # A pagination token returned from a previous call - # that indicates where this listing should continue from. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::OsconfigV1beta::ListPatchJobInstanceDetailsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::OsconfigV1beta::ListPatchJobInstanceDetailsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_patch_job_instance_details(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta/{+parent}/instanceDetails', options) - command.response_representation = Google::Apis::OsconfigV1beta::ListPatchJobInstanceDetailsResponse::Representation - command.response_class = Google::Apis::OsconfigV1beta::ListPatchJobInstanceDetailsResponse - command.params['parent'] = parent unless parent.nil? - command.query['filter'] = filter unless filter.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lookup the effective guest policy that applies to a VM instance. This - # lookup merges all policies that are assigned to the instance ancestry. - # @param [String] instance - # Required. The VM instance whose policies are being looked up. - # @param [Google::Apis::OsconfigV1beta::LookupEffectiveGuestPolicyRequest] lookup_effective_guest_policy_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::OsconfigV1beta::EffectiveGuestPolicy] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::OsconfigV1beta::EffectiveGuestPolicy] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def lookup_instance_effective_guest_policy(instance, lookup_effective_guest_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta/{+instance}:lookupEffectiveGuestPolicy', options) - command.request_representation = Google::Apis::OsconfigV1beta::LookupEffectiveGuestPolicyRequest::Representation - command.request_object = lookup_effective_guest_policy_request_object - command.response_representation = Google::Apis::OsconfigV1beta::EffectiveGuestPolicy::Representation - command.response_class = Google::Apis::OsconfigV1beta::EffectiveGuestPolicy - command.params['instance'] = instance unless instance.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - protected - - def apply_command_defaults(command) - command.query['key'] = key unless key.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - end - end - end - end -end diff --git a/generated/google/apis/people_v1.rb b/generated/google/apis/people_v1.rb index d8e5a8686..f51dfced1 100644 --- a/generated/google/apis/people_v1.rb +++ b/generated/google/apis/people_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/people/ module PeopleV1 VERSION = 'V1' - REVISION = '20200407' + REVISION = '20200427' # See, edit, download, and permanently delete your contacts AUTH_CONTACTS = 'https://www.googleapis.com/auth/contacts' @@ -33,6 +33,9 @@ module Google # See and download your contacts AUTH_CONTACTS_READONLY = 'https://www.googleapis.com/auth/contacts.readonly' + # See and download your organization's GSuite directory + AUTH_DIRECTORY_READONLY = 'https://www.googleapis.com/auth/directory.readonly' + # View your street addresses AUTH_USER_ADDRESSES_READ = 'https://www.googleapis.com/auth/user.addresses.read' @@ -42,6 +45,9 @@ module Google # View your email addresses AUTH_USER_EMAILS_READ = 'https://www.googleapis.com/auth/user.emails.read' + # See your gender + AUTH_USER_GENDER_READ = 'https://www.googleapis.com/auth/user.gender.read' + # See your education, work history and org info AUTH_USER_ORGANIZATION_READ = 'https://www.googleapis.com/auth/user.organization.read' diff --git a/generated/google/apis/policytroubleshooter_v1.rb b/generated/google/apis/policytroubleshooter_v1.rb index 199b35607..dc40b1585 100644 --- a/generated/google/apis/policytroubleshooter_v1.rb +++ b/generated/google/apis/policytroubleshooter_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/iam/ module PolicytroubleshooterV1 VERSION = 'V1' - REVISION = '20200210' + REVISION = '20200504' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/policytroubleshooter_v1/classes.rb b/generated/google/apis/policytroubleshooter_v1/classes.rb index a295a4a09..511315130 100644 --- a/generated/google/apis/policytroubleshooter_v1/classes.rb +++ b/generated/google/apis/policytroubleshooter_v1/classes.rb @@ -239,10 +239,13 @@ module Google # 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. - # Optionally, a `binding` can 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. + # 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": [ @@ -257,7 +260,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -572,10 +577,13 @@ module Google # 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. - # Optionally, a `binding` can 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. + # 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": [ @@ -590,7 +598,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -668,6 +678,9 @@ module Google # 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 diff --git a/generated/google/apis/policytroubleshooter_v1beta.rb b/generated/google/apis/policytroubleshooter_v1beta.rb index 5d0c98600..e444c221a 100644 --- a/generated/google/apis/policytroubleshooter_v1beta.rb +++ b/generated/google/apis/policytroubleshooter_v1beta.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/iam/ module PolicytroubleshooterV1beta VERSION = 'V1beta' - REVISION = '20200210' + REVISION = '20200504' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/policytroubleshooter_v1beta/classes.rb b/generated/google/apis/policytroubleshooter_v1beta/classes.rb index f88aff19f..a7f8fa449 100644 --- a/generated/google/apis/policytroubleshooter_v1beta/classes.rb +++ b/generated/google/apis/policytroubleshooter_v1beta/classes.rb @@ -238,10 +238,13 @@ module Google # 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. - # Optionally, a `binding` can 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. + # 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": [ @@ -256,7 +259,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -571,10 +576,13 @@ module Google # 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. - # Optionally, a `binding` can 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. + # 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": [ @@ -589,7 +597,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -667,6 +677,9 @@ module Google # 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 diff --git a/generated/google/apis/prod_tt_sasportal_v1alpha1.rb b/generated/google/apis/prod_tt_sasportal_v1alpha1.rb index ea2625e7c..70005da8e 100644 --- a/generated/google/apis/prod_tt_sasportal_v1alpha1.rb +++ b/generated/google/apis/prod_tt_sasportal_v1alpha1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/spectrum-access-system/ module ProdTtSasportalV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200405' + REVISION = '20200416' # View your email address AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email' diff --git a/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb b/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb index bd2663d81..910e35c61 100644 --- a/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb +++ b/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb @@ -354,6 +354,11 @@ module Google # @return [String] attr_accessor :state + # If the grant is suspended, the reason(s) for suspension. + # Corresponds to the JSON property `suspensionReason` + # @return [Array] + attr_accessor :suspension_reason + def initialize(**args) update!(**args) end @@ -366,6 +371,7 @@ module Google @max_eirp = args[:max_eirp] if args.key?(:max_eirp) @move_list = args[:move_list] if args.key?(:move_list) @state = args[:state] if args.key?(:state) + @suspension_reason = args[:suspension_reason] if args.key?(:suspension_reason) end end @@ -577,6 +583,12 @@ module Google # @return [String] attr_accessor :antenna_model + # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. + # Corresponds to the JSON property `cpeCbsdIndication` + # @return [Boolean] + attr_accessor :cpe_cbsd_indication + alias_method :cpe_cbsd_indication?, :cpe_cbsd_indication + # This parameter is the maximum device EIRP in units of dBm/10MHz # and is an integer with a value between -127 and +47 (dBm/10 MHz) # inclusive. If not included, SAS interprets it as maximum @@ -649,6 +661,7 @@ module Google @antenna_downtilt = args[:antenna_downtilt] if args.key?(:antenna_downtilt) @antenna_gain = args[:antenna_gain] if args.key?(:antenna_gain) @antenna_model = args[:antenna_model] if args.key?(:antenna_model) + @cpe_cbsd_indication = args[:cpe_cbsd_indication] if args.key?(:cpe_cbsd_indication) @eirp_capability = args[:eirp_capability] if args.key?(:eirp_capability) @height = args[:height] if args.key?(:height) @height_type = args[:height_type] if args.key?(:height_type) diff --git a/generated/google/apis/prod_tt_sasportal_v1alpha1/representations.rb b/generated/google/apis/prod_tt_sasportal_v1alpha1/representations.rb index 9b6e3018e..6cadaec4a 100644 --- a/generated/google/apis/prod_tt_sasportal_v1alpha1/representations.rb +++ b/generated/google/apis/prod_tt_sasportal_v1alpha1/representations.rb @@ -315,6 +315,7 @@ module Google collection :move_list, as: 'moveList', class: Google::Apis::ProdTtSasportalV1alpha1::SasPortalDpaMoveList, decorator: Google::Apis::ProdTtSasportalV1alpha1::SasPortalDpaMoveList::Representation property :state, as: 'state' + collection :suspension_reason, as: 'suspensionReason' end end @@ -380,6 +381,7 @@ module Google property :antenna_downtilt, as: 'antennaDowntilt' property :antenna_gain, as: 'antennaGain' property :antenna_model, as: 'antennaModel' + property :cpe_cbsd_indication, as: 'cpeCbsdIndication' property :eirp_capability, as: 'eirpCapability' property :height, as: 'height' property :height_type, as: 'heightType' diff --git a/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb b/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb index d6a857f10..cfbb31a54 100644 --- a/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb +++ b/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb @@ -318,6 +318,8 @@ module Google # corresponds to serial_number of the device. The filter is case insensitive. # @param [Fixnum] page_size # The maximum number of devices to return in the response. + # If empty or zero, all devices will be listed. + # Must be in the range [0, 1000]. # @param [String] page_token # A pagination token returned from a previous call to ListDevices # that indicates where this listing should continue from. @@ -985,6 +987,8 @@ module Google # corresponds to serial_number of the device. The filter is case insensitive. # @param [Fixnum] page_size # The maximum number of devices to return in the response. + # If empty or zero, all devices will be listed. + # Must be in the range [0, 1000]. # @param [String] page_token # A pagination token returned from a previous call to ListDevices # that indicates where this listing should continue from. @@ -1462,6 +1466,8 @@ module Google # corresponds to serial_number of the device. The filter is case insensitive. # @param [Fixnum] page_size # The maximum number of devices to return in the response. + # If empty or zero, all devices will be listed. + # Must be in the range [0, 1000]. # @param [String] page_token # A pagination token returned from a previous call to ListDevices # that indicates where this listing should continue from. diff --git a/generated/google/apis/remotebuildexecution_v1.rb b/generated/google/apis/remotebuildexecution_v1.rb index 49cb4dab9..dc3ea7411 100644 --- a/generated/google/apis/remotebuildexecution_v1.rb +++ b/generated/google/apis/remotebuildexecution_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/remote-build-execution/docs/ module RemotebuildexecutionV1 VERSION = 'V1' - REVISION = '20200324' + REVISION = '20200505' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/remotebuildexecution_v1/classes.rb b/generated/google/apis/remotebuildexecution_v1/classes.rb index c358e0b62..3b376bf09 100644 --- a/generated/google/apis/remotebuildexecution_v1/classes.rb +++ b/generated/google/apis/remotebuildexecution_v1/classes.rb @@ -1832,6 +1832,31 @@ module Google end end + # Autoscale defines the autoscaling policy of a worker pool. + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale + include Google::Apis::Core::Hashable + + # The maximal number of workers. Must be equal to or greater than min_size. + # Corresponds to the JSON property `maxSize` + # @return [Fixnum] + attr_accessor :max_size + + # The minimal number of workers. Must be greater than 0. + # Corresponds to the JSON property `minSize` + # @return [Fixnum] + attr_accessor :min_size + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @max_size = args[:max_size] if args.key?(:max_size) + @min_size = args[:min_size] if args.key?(:min_size) + end + end + # The request used for `CreateInstance`. class GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest include Google::Apis::Core::Hashable @@ -2146,19 +2171,37 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateInstanceRequest include Google::Apis::Core::Hashable + # Instance conceptually encapsulates all Remote Build Execution resources + # for remote builds. + # An instance consists of storage and compute resources (for example, + # `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for + # running remote builds. + # All Remote Build Execution API calls are scoped to an instance. + # Corresponds to the JSON property `instance` + # @return [Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance] + attr_accessor :instance + + # Deprecated, use instance.logging_enabled instead. # Whether to enable Stackdriver logging for this instance. # Corresponds to the JSON property `loggingEnabled` # @return [Boolean] attr_accessor :logging_enabled alias_method :logging_enabled?, :logging_enabled + # Deprecated, use instance.Name instead. # Name of the instance to update. # Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The fields to update. + # The update mask applies to instance. For the `FieldMask` definition, see + # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# + # fieldmask + # If an empty update_mask is provided, only the non-default valued field in + # the worker pool field will be updated. Note that in order to update a field + # to the default value (zero, false, empty string) an explicit update_mask + # must be provided. # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask @@ -2169,6 +2212,7 @@ module Google # Update properties of this object def update!(**args) + @instance = args[:instance] if args.key?(:instance) @logging_enabled = args[:logging_enabled] if args.key?(:logging_enabled) @name = args[:name] if args.key?(:name) @update_mask = args[:update_mask] if args.key?(:update_mask) @@ -2300,6 +2344,16 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool include Google::Apis::Core::Hashable + # Autoscale defines the autoscaling policy of a worker pool. + # Corresponds to the JSON property `autoscale` + # @return [Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale] + attr_accessor :autoscale + + # Channel specifies the release channel of the pool. + # Corresponds to the JSON property `channel` + # @return [String] + attr_accessor :channel + # WorkerPool resource name formatted as: # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. # name should not be populated when creating a worker pool since it is @@ -2331,6 +2385,8 @@ module Google # Update properties of this object def update!(**args) + @autoscale = args[:autoscale] if args.key?(:autoscale) + @channel = args[:channel] if args.key?(:channel) @name = args[:name] if args.key?(:name) @state = args[:state] if args.key?(:state) @worker_config = args[:worker_config] if args.key?(:worker_config) diff --git a/generated/google/apis/remotebuildexecution_v1/representations.rb b/generated/google/apis/remotebuildexecution_v1/representations.rb index 280035184..1ec81ad54 100644 --- a/generated/google/apis/remotebuildexecution_v1/representations.rb +++ b/generated/google/apis/remotebuildexecution_v1/representations.rb @@ -196,6 +196,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -718,6 +724,14 @@ module Google end end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :max_size, :numeric_string => true, as: 'maxSize' + property :min_size, :numeric_string => true, as: 'minSize' + end + end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -810,6 +824,8 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateInstanceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation + property :instance, as: 'instance', class: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance, decorator: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance::Representation + property :logging_enabled, as: 'loggingEnabled' property :name, as: 'name' property :update_mask, as: 'updateMask' @@ -844,6 +860,9 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool # @private class Representation < Google::Apis::Core::JsonRepresentation + property :autoscale, as: 'autoscale', class: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale, decorator: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale::Representation + + property :channel, as: 'channel' property :name, as: 'name' property :state, as: 'state' property :worker_config, as: 'workerConfig', class: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig, decorator: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig::Representation diff --git a/generated/google/apis/remotebuildexecution_v1alpha.rb b/generated/google/apis/remotebuildexecution_v1alpha.rb index 38d906d7d..303940826 100644 --- a/generated/google/apis/remotebuildexecution_v1alpha.rb +++ b/generated/google/apis/remotebuildexecution_v1alpha.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/remote-build-execution/docs/ module RemotebuildexecutionV1alpha VERSION = 'V1alpha' - REVISION = '20200324' + REVISION = '20200505' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/remotebuildexecution_v1alpha/classes.rb b/generated/google/apis/remotebuildexecution_v1alpha/classes.rb index 3bcb37eec..7628f0174 100644 --- a/generated/google/apis/remotebuildexecution_v1alpha/classes.rb +++ b/generated/google/apis/remotebuildexecution_v1alpha/classes.rb @@ -1813,6 +1813,31 @@ module Google end end + # Autoscale defines the autoscaling policy of a worker pool. + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale + include Google::Apis::Core::Hashable + + # The maximal number of workers. Must be equal to or greater than min_size. + # Corresponds to the JSON property `maxSize` + # @return [Fixnum] + attr_accessor :max_size + + # The minimal number of workers. Must be greater than 0. + # Corresponds to the JSON property `minSize` + # @return [Fixnum] + attr_accessor :min_size + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @max_size = args[:max_size] if args.key?(:max_size) + @min_size = args[:min_size] if args.key?(:min_size) + end + end + # The request used for `CreateInstance`. class GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest include Google::Apis::Core::Hashable @@ -2127,19 +2152,37 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateInstanceRequest include Google::Apis::Core::Hashable + # Instance conceptually encapsulates all Remote Build Execution resources + # for remote builds. + # An instance consists of storage and compute resources (for example, + # `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for + # running remote builds. + # All Remote Build Execution API calls are scoped to an instance. + # Corresponds to the JSON property `instance` + # @return [Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance] + attr_accessor :instance + + # Deprecated, use instance.logging_enabled instead. # Whether to enable Stackdriver logging for this instance. # Corresponds to the JSON property `loggingEnabled` # @return [Boolean] attr_accessor :logging_enabled alias_method :logging_enabled?, :logging_enabled + # Deprecated, use instance.Name instead. # Name of the instance to update. # Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The fields to update. + # The update mask applies to instance. For the `FieldMask` definition, see + # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# + # fieldmask + # If an empty update_mask is provided, only the non-default valued field in + # the worker pool field will be updated. Note that in order to update a field + # to the default value (zero, false, empty string) an explicit update_mask + # must be provided. # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask @@ -2150,6 +2193,7 @@ module Google # Update properties of this object def update!(**args) + @instance = args[:instance] if args.key?(:instance) @logging_enabled = args[:logging_enabled] if args.key?(:logging_enabled) @name = args[:name] if args.key?(:name) @update_mask = args[:update_mask] if args.key?(:update_mask) @@ -2281,6 +2325,16 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool include Google::Apis::Core::Hashable + # Autoscale defines the autoscaling policy of a worker pool. + # Corresponds to the JSON property `autoscale` + # @return [Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale] + attr_accessor :autoscale + + # Channel specifies the release channel of the pool. + # Corresponds to the JSON property `channel` + # @return [String] + attr_accessor :channel + # WorkerPool resource name formatted as: # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. # name should not be populated when creating a worker pool since it is @@ -2312,6 +2366,8 @@ module Google # Update properties of this object def update!(**args) + @autoscale = args[:autoscale] if args.key?(:autoscale) + @channel = args[:channel] if args.key?(:channel) @name = args[:name] if args.key?(:name) @state = args[:state] if args.key?(:state) @worker_config = args[:worker_config] if args.key?(:worker_config) diff --git a/generated/google/apis/remotebuildexecution_v1alpha/representations.rb b/generated/google/apis/remotebuildexecution_v1alpha/representations.rb index f7bc9561b..fc295ec5b 100644 --- a/generated/google/apis/remotebuildexecution_v1alpha/representations.rb +++ b/generated/google/apis/remotebuildexecution_v1alpha/representations.rb @@ -190,6 +190,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -687,6 +693,14 @@ module Google end end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :max_size, :numeric_string => true, as: 'maxSize' + property :min_size, :numeric_string => true, as: 'minSize' + end + end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -779,6 +793,8 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateInstanceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation + property :instance, as: 'instance', class: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance, decorator: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance::Representation + property :logging_enabled, as: 'loggingEnabled' property :name, as: 'name' property :update_mask, as: 'updateMask' @@ -813,6 +829,9 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool # @private class Representation < Google::Apis::Core::JsonRepresentation + property :autoscale, as: 'autoscale', class: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale, decorator: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale::Representation + + property :channel, as: 'channel' property :name, as: 'name' property :state, as: 'state' property :worker_config, as: 'workerConfig', class: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig, decorator: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig::Representation diff --git a/generated/google/apis/remotebuildexecution_v2.rb b/generated/google/apis/remotebuildexecution_v2.rb index 4cd7e315e..dd190b9d1 100644 --- a/generated/google/apis/remotebuildexecution_v2.rb +++ b/generated/google/apis/remotebuildexecution_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/remote-build-execution/docs/ module RemotebuildexecutionV2 VERSION = 'V2' - REVISION = '20200324' + REVISION = '20200505' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/remotebuildexecution_v2/classes.rb b/generated/google/apis/remotebuildexecution_v2/classes.rb index ac0be9434..2b869e880 100644 --- a/generated/google/apis/remotebuildexecution_v2/classes.rb +++ b/generated/google/apis/remotebuildexecution_v2/classes.rb @@ -2512,6 +2512,31 @@ module Google end end + # Autoscale defines the autoscaling policy of a worker pool. + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale + include Google::Apis::Core::Hashable + + # The maximal number of workers. Must be equal to or greater than min_size. + # Corresponds to the JSON property `maxSize` + # @return [Fixnum] + attr_accessor :max_size + + # The minimal number of workers. Must be greater than 0. + # Corresponds to the JSON property `minSize` + # @return [Fixnum] + attr_accessor :min_size + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @max_size = args[:max_size] if args.key?(:max_size) + @min_size = args[:min_size] if args.key?(:min_size) + end + end + # The request used for `CreateInstance`. class GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest include Google::Apis::Core::Hashable @@ -2826,19 +2851,37 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateInstanceRequest include Google::Apis::Core::Hashable + # Instance conceptually encapsulates all Remote Build Execution resources + # for remote builds. + # An instance consists of storage and compute resources (for example, + # `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for + # running remote builds. + # All Remote Build Execution API calls are scoped to an instance. + # Corresponds to the JSON property `instance` + # @return [Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance] + attr_accessor :instance + + # Deprecated, use instance.logging_enabled instead. # Whether to enable Stackdriver logging for this instance. # Corresponds to the JSON property `loggingEnabled` # @return [Boolean] attr_accessor :logging_enabled alias_method :logging_enabled?, :logging_enabled + # Deprecated, use instance.Name instead. # Name of the instance to update. # Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The fields to update. + # The update mask applies to instance. For the `FieldMask` definition, see + # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# + # fieldmask + # If an empty update_mask is provided, only the non-default valued field in + # the worker pool field will be updated. Note that in order to update a field + # to the default value (zero, false, empty string) an explicit update_mask + # must be provided. # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask @@ -2849,6 +2892,7 @@ module Google # Update properties of this object def update!(**args) + @instance = args[:instance] if args.key?(:instance) @logging_enabled = args[:logging_enabled] if args.key?(:logging_enabled) @name = args[:name] if args.key?(:name) @update_mask = args[:update_mask] if args.key?(:update_mask) @@ -2980,6 +3024,16 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool include Google::Apis::Core::Hashable + # Autoscale defines the autoscaling policy of a worker pool. + # Corresponds to the JSON property `autoscale` + # @return [Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale] + attr_accessor :autoscale + + # Channel specifies the release channel of the pool. + # Corresponds to the JSON property `channel` + # @return [String] + attr_accessor :channel + # WorkerPool resource name formatted as: # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. # name should not be populated when creating a worker pool since it is @@ -3011,6 +3065,8 @@ module Google # Update properties of this object def update!(**args) + @autoscale = args[:autoscale] if args.key?(:autoscale) + @channel = args[:channel] if args.key?(:channel) @name = args[:name] if args.key?(:name) @state = args[:state] if args.key?(:state) @worker_config = args[:worker_config] if args.key?(:worker_config) diff --git a/generated/google/apis/remotebuildexecution_v2/representations.rb b/generated/google/apis/remotebuildexecution_v2/representations.rb index d9e156d6f..35c339330 100644 --- a/generated/google/apis/remotebuildexecution_v2/representations.rb +++ b/generated/google/apis/remotebuildexecution_v2/representations.rb @@ -316,6 +316,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1006,6 +1012,14 @@ module Google end end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :max_size, :numeric_string => true, as: 'maxSize' + property :min_size, :numeric_string => true, as: 'minSize' + end + end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1098,6 +1112,8 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateInstanceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation + property :instance, as: 'instance', class: Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance, decorator: Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance::Representation + property :logging_enabled, as: 'loggingEnabled' property :name, as: 'name' property :update_mask, as: 'updateMask' @@ -1132,6 +1148,9 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool # @private class Representation < Google::Apis::Core::JsonRepresentation + property :autoscale, as: 'autoscale', class: Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale, decorator: Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale::Representation + + property :channel, as: 'channel' property :name, as: 'name' property :state, as: 'state' property :worker_config, as: 'workerConfig', class: Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig, decorator: Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig::Representation diff --git a/generated/google/apis/run_v1.rb b/generated/google/apis/run_v1.rb index 7c1c10dfc..dbb1172f3 100644 --- a/generated/google/apis/run_v1.rb +++ b/generated/google/apis/run_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/run/ module RunV1 VERSION = 'V1' - REVISION = '20200407' + REVISION = '20200415' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/run_v1/classes.rb b/generated/google/apis/run_v1/classes.rb index 6e77dfe05..f43857f85 100644 --- a/generated/google/apis/run_v1/classes.rb +++ b/generated/google/apis/run_v1/classes.rb @@ -3178,8 +3178,7 @@ module Google # 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" - # This field is only used by Cloud IAM. + # `paths: "bindings, etag"` # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask diff --git a/generated/google/apis/run_v1alpha1.rb b/generated/google/apis/run_v1alpha1.rb index cd791d08b..0c2bd6be7 100644 --- a/generated/google/apis/run_v1alpha1.rb +++ b/generated/google/apis/run_v1alpha1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/run/ module RunV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200407' + REVISION = '20200415' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/run_v1alpha1/classes.rb b/generated/google/apis/run_v1alpha1/classes.rb index 59341d309..a7e8075ac 100644 --- a/generated/google/apis/run_v1alpha1/classes.rb +++ b/generated/google/apis/run_v1alpha1/classes.rb @@ -3349,21 +3349,16 @@ module Google class Probe include Google::Apis::Core::Hashable - # ExecAction describes a "run in container" action. - # Corresponds to the JSON property `exec` - # @return [Google::Apis::RunV1alpha1::ExecAction] - attr_accessor :exec - # Minimum consecutive failures for the probe to be considered failed after # having succeeded. Defaults to 3. Minimum value is 1. +optional # Corresponds to the JSON property `failureThreshold` # @return [Fixnum] attr_accessor :failure_threshold - # HTTPGetAction describes an action based on HTTP Get requests. - # Corresponds to the JSON property `httpGet` - # @return [Google::Apis::RunV1alpha1::HttpGetAction] - attr_accessor :http_get + # Handler defines a specific action that should be taken + # Corresponds to the JSON property `handler` + # @return [Google::Apis::RunV1alpha1::Handler] + attr_accessor :handler # Number of seconds after the container has started before liveness probes # are initiated. More info: @@ -3388,11 +3383,6 @@ module Google # @return [Fixnum] attr_accessor :success_threshold - # TCPSocketAction describes an action based on opening a socket - # Corresponds to the JSON property `tcpSocket` - # @return [Google::Apis::RunV1alpha1::TcpSocketAction] - attr_accessor :tcp_socket - # Number of seconds after which the probe times out. # Defaults to 1 second. Minimum value is 1. # More info: @@ -3409,13 +3399,11 @@ module Google # Update properties of this object def update!(**args) - @exec = args[:exec] if args.key?(:exec) @failure_threshold = args[:failure_threshold] if args.key?(:failure_threshold) - @http_get = args[:http_get] if args.key?(:http_get) + @handler = args[:handler] if args.key?(:handler) @initial_delay_seconds = args[:initial_delay_seconds] if args.key?(:initial_delay_seconds) @period_seconds = args[:period_seconds] if args.key?(:period_seconds) @success_threshold = args[:success_threshold] if args.key?(:success_threshold) - @tcp_socket = args[:tcp_socket] if args.key?(:tcp_socket) @timeout_seconds = args[:timeout_seconds] if args.key?(:timeout_seconds) end end @@ -4744,8 +4732,7 @@ module Google # 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" - # This field is only used by Cloud IAM. + # `paths: "bindings, etag"` # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask diff --git a/generated/google/apis/run_v1alpha1/representations.rb b/generated/google/apis/run_v1alpha1/representations.rb index 1acd07a2c..f0316162d 100644 --- a/generated/google/apis/run_v1alpha1/representations.rb +++ b/generated/google/apis/run_v1alpha1/representations.rb @@ -1419,16 +1419,12 @@ module Google class Probe # @private class Representation < Google::Apis::Core::JsonRepresentation - property :exec, as: 'exec', class: Google::Apis::RunV1alpha1::ExecAction, decorator: Google::Apis::RunV1alpha1::ExecAction::Representation - property :failure_threshold, as: 'failureThreshold' - property :http_get, as: 'httpGet', class: Google::Apis::RunV1alpha1::HttpGetAction, decorator: Google::Apis::RunV1alpha1::HttpGetAction::Representation + property :handler, as: 'handler', class: Google::Apis::RunV1alpha1::Handler, decorator: Google::Apis::RunV1alpha1::Handler::Representation property :initial_delay_seconds, as: 'initialDelaySeconds' property :period_seconds, as: 'periodSeconds' property :success_threshold, as: 'successThreshold' - property :tcp_socket, as: 'tcpSocket', class: Google::Apis::RunV1alpha1::TcpSocketAction, decorator: Google::Apis::RunV1alpha1::TcpSocketAction::Representation - property :timeout_seconds, as: 'timeoutSeconds' end end diff --git a/generated/google/apis/runtimeconfig_v1beta1.rb b/generated/google/apis/runtimeconfig_v1beta1.rb index 6338715cb..18f4eb61e 100644 --- a/generated/google/apis/runtimeconfig_v1beta1.rb +++ b/generated/google/apis/runtimeconfig_v1beta1.rb @@ -28,7 +28,7 @@ module Google # @see https://cloud.google.com/deployment-manager/runtime-configurator/ module RuntimeconfigV1beta1 VERSION = 'V1beta1' - REVISION = '20200224' + REVISION = '20200504' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/runtimeconfig_v1beta1/classes.rb b/generated/google/apis/runtimeconfig_v1beta1/classes.rb index 08add6ddc..d6e5fc8b1 100644 --- a/generated/google/apis/runtimeconfig_v1beta1/classes.rb +++ b/generated/google/apis/runtimeconfig_v1beta1/classes.rb @@ -416,10 +416,13 @@ module Google # 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. - # Optionally, a `binding` can 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. + # 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": [ @@ -434,7 +437,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -507,6 +512,9 @@ module Google # 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 @@ -569,10 +577,13 @@ module Google # 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. - # Optionally, a `binding` can 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. + # 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": [ @@ -587,7 +598,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", diff --git a/generated/google/apis/runtimeconfig_v1beta1/service.rb b/generated/google/apis/runtimeconfig_v1beta1/service.rb index 699983507..591683b43 100644 --- a/generated/google/apis/runtimeconfig_v1beta1/service.rb +++ b/generated/google/apis/runtimeconfig_v1beta1/service.rb @@ -171,6 +171,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value 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). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -241,7 +244,7 @@ module Google # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. @@ -277,7 +280,7 @@ module Google # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. @@ -382,7 +385,7 @@ module Google # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. @@ -595,7 +598,7 @@ module Google # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. @@ -864,7 +867,7 @@ module Google # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. diff --git a/generated/google/apis/sasportal_v1alpha1.rb b/generated/google/apis/sasportal_v1alpha1.rb index 0c43c3afe..7f380e52e 100644 --- a/generated/google/apis/sasportal_v1alpha1.rb +++ b/generated/google/apis/sasportal_v1alpha1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/spectrum-access-system/ module SasportalV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200405' + REVISION = '20200416' # View your email address AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email' diff --git a/generated/google/apis/sasportal_v1alpha1/classes.rb b/generated/google/apis/sasportal_v1alpha1/classes.rb index 5bb72cce6..613d08cef 100644 --- a/generated/google/apis/sasportal_v1alpha1/classes.rb +++ b/generated/google/apis/sasportal_v1alpha1/classes.rb @@ -354,6 +354,11 @@ module Google # @return [String] attr_accessor :state + # If the grant is suspended, the reason(s) for suspension. + # Corresponds to the JSON property `suspensionReason` + # @return [Array] + attr_accessor :suspension_reason + def initialize(**args) update!(**args) end @@ -366,6 +371,7 @@ module Google @max_eirp = args[:max_eirp] if args.key?(:max_eirp) @move_list = args[:move_list] if args.key?(:move_list) @state = args[:state] if args.key?(:state) + @suspension_reason = args[:suspension_reason] if args.key?(:suspension_reason) end end @@ -577,6 +583,12 @@ module Google # @return [String] attr_accessor :antenna_model + # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. + # Corresponds to the JSON property `cpeCbsdIndication` + # @return [Boolean] + attr_accessor :cpe_cbsd_indication + alias_method :cpe_cbsd_indication?, :cpe_cbsd_indication + # This parameter is the maximum device EIRP in units of dBm/10MHz # and is an integer with a value between -127 and +47 (dBm/10 MHz) # inclusive. If not included, SAS interprets it as maximum @@ -649,6 +661,7 @@ module Google @antenna_downtilt = args[:antenna_downtilt] if args.key?(:antenna_downtilt) @antenna_gain = args[:antenna_gain] if args.key?(:antenna_gain) @antenna_model = args[:antenna_model] if args.key?(:antenna_model) + @cpe_cbsd_indication = args[:cpe_cbsd_indication] if args.key?(:cpe_cbsd_indication) @eirp_capability = args[:eirp_capability] if args.key?(:eirp_capability) @height = args[:height] if args.key?(:height) @height_type = args[:height_type] if args.key?(:height_type) diff --git a/generated/google/apis/sasportal_v1alpha1/representations.rb b/generated/google/apis/sasportal_v1alpha1/representations.rb index 1ffd690ed..2a20e2ca5 100644 --- a/generated/google/apis/sasportal_v1alpha1/representations.rb +++ b/generated/google/apis/sasportal_v1alpha1/representations.rb @@ -315,6 +315,7 @@ module Google collection :move_list, as: 'moveList', class: Google::Apis::SasportalV1alpha1::SasPortalDpaMoveList, decorator: Google::Apis::SasportalV1alpha1::SasPortalDpaMoveList::Representation property :state, as: 'state' + collection :suspension_reason, as: 'suspensionReason' end end @@ -380,6 +381,7 @@ module Google property :antenna_downtilt, as: 'antennaDowntilt' property :antenna_gain, as: 'antennaGain' property :antenna_model, as: 'antennaModel' + property :cpe_cbsd_indication, as: 'cpeCbsdIndication' property :eirp_capability, as: 'eirpCapability' property :height, as: 'height' property :height_type, as: 'heightType' diff --git a/generated/google/apis/sasportal_v1alpha1/service.rb b/generated/google/apis/sasportal_v1alpha1/service.rb index 9c12aaa48..6bcf71c6a 100644 --- a/generated/google/apis/sasportal_v1alpha1/service.rb +++ b/generated/google/apis/sasportal_v1alpha1/service.rb @@ -318,6 +318,8 @@ module Google # corresponds to serial_number of the device. The filter is case insensitive. # @param [Fixnum] page_size # The maximum number of devices to return in the response. + # If empty or zero, all devices will be listed. + # Must be in the range [0, 1000]. # @param [String] page_token # A pagination token returned from a previous call to ListDevices # that indicates where this listing should continue from. @@ -985,6 +987,8 @@ module Google # corresponds to serial_number of the device. The filter is case insensitive. # @param [Fixnum] page_size # The maximum number of devices to return in the response. + # If empty or zero, all devices will be listed. + # Must be in the range [0, 1000]. # @param [String] page_token # A pagination token returned from a previous call to ListDevices # that indicates where this listing should continue from. @@ -1462,6 +1466,8 @@ module Google # corresponds to serial_number of the device. The filter is case insensitive. # @param [Fixnum] page_size # The maximum number of devices to return in the response. + # If empty or zero, all devices will be listed. + # Must be in the range [0, 1000]. # @param [String] page_token # A pagination token returned from a previous call to ListDevices # that indicates where this listing should continue from. diff --git a/generated/google/apis/script_v1.rb b/generated/google/apis/script_v1.rb index 4137e80c7..a581bd985 100644 --- a/generated/google/apis/script_v1.rb +++ b/generated/google/apis/script_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/apps-script/api/ module ScriptV1 VERSION = 'V1' - REVISION = '20200215' + REVISION = '20200411' # Read, compose, send, and permanently delete all your email from Gmail AUTH_SCOPE = 'https://mail.google.com/' diff --git a/generated/google/apis/script_v1/classes.rb b/generated/google/apis/script_v1/classes.rb index 30d3ae03c..e18a00928 100644 --- a/generated/google/apis/script_v1/classes.rb +++ b/generated/google/apis/script_v1/classes.rb @@ -211,10 +211,7 @@ module Google class ExecuteStreamResponse include Google::Apis::Core::Hashable - # The result of an execution - # Based on ScriptExecutionResult at: - # google3/apps/maestro/api/frontend_execution_common.proto?q=message%5c% - # 20ScriptExecutionResult + # The result of an execution. # Corresponds to the JSON property `result` # @return [Google::Apis::ScriptV1::ScriptExecutionResult] attr_accessor :result @@ -769,8 +766,6 @@ module Google end # `ListValue` is a wrapper around a repeated field of values. - # Based on LustValue at: - # google3/apps/maestro/api/struct.proto?q=message%5c%20ListValue class ListValue include Google::Apis::Core::Hashable @@ -995,17 +990,12 @@ module Google end end - # The result of an execution - # Based on ScriptExecutionResult at: - # google3/apps/maestro/api/frontend_execution_common.proto?q=message%5c% - # 20ScriptExecutionResult + # The result of an execution. class ScriptExecutionResult include Google::Apis::Core::Hashable # `Value` represents a dynamically typed value which is the outcome of an - # executed script - # Based on Value at: - # google3/apps/maestro/api/struct.proto?q=message%5c%20Value + # executed script. # Corresponds to the JSON property `returnValue` # @return [Google::Apis::ScriptV1::Value] attr_accessor :return_value @@ -1084,8 +1074,6 @@ module Google # `Struct` represents a structured data value, consisting of fields which map # to dynamically typed values. - # Based on Struct at: - # google3/apps/maestro/api/struct.proto?q=message%5c%20Struct class Struct include Google::Apis::Core::Hashable @@ -1124,9 +1112,7 @@ module Google end # `Value` represents a dynamically typed value which is the outcome of an - # executed script - # Based on Value at: - # google3/apps/maestro/api/struct.proto?q=message%5c%20Value + # executed script. class Value include Google::Apis::Core::Hashable @@ -1148,8 +1134,6 @@ module Google attr_accessor :date_value # `ListValue` is a wrapper around a repeated field of values. - # Based on LustValue at: - # google3/apps/maestro/api/struct.proto?q=message%5c%20ListValue # Corresponds to the JSON property `listValue` # @return [Google::Apis::ScriptV1::ListValue] attr_accessor :list_value @@ -1176,8 +1160,6 @@ module Google # `Struct` represents a structured data value, consisting of fields which map # to dynamically typed values. - # Based on Struct at: - # google3/apps/maestro/api/struct.proto?q=message%5c%20Struct # Corresponds to the JSON property `structValue` # @return [Google::Apis::ScriptV1::Struct] attr_accessor :struct_value diff --git a/generated/google/apis/secretmanager_v1.rb b/generated/google/apis/secretmanager_v1.rb index 0ff6d7ad9..21f0b5ddd 100644 --- a/generated/google/apis/secretmanager_v1.rb +++ b/generated/google/apis/secretmanager_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/secret-manager/ module SecretmanagerV1 VERSION = 'V1' - REVISION = '20200403' + REVISION = '20200413' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/secretmanager_v1/classes.rb b/generated/google/apis/secretmanager_v1/classes.rb index 06d6acf9d..3696bc52a 100644 --- a/generated/google/apis/secretmanager_v1/classes.rb +++ b/generated/google/apis/secretmanager_v1/classes.rb @@ -886,8 +886,7 @@ module Google # 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" - # This field is only used by Cloud IAM. + # `paths: "bindings, etag"` # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask diff --git a/generated/google/apis/secretmanager_v1beta1.rb b/generated/google/apis/secretmanager_v1beta1.rb index 80fae46e7..feca57fef 100644 --- a/generated/google/apis/secretmanager_v1beta1.rb +++ b/generated/google/apis/secretmanager_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/secret-manager/ module SecretmanagerV1beta1 VERSION = 'V1beta1' - REVISION = '20200403' + REVISION = '20200413' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/secretmanager_v1beta1/classes.rb b/generated/google/apis/secretmanager_v1beta1/classes.rb index 3749d0e94..cc6339ddb 100644 --- a/generated/google/apis/secretmanager_v1beta1/classes.rb +++ b/generated/google/apis/secretmanager_v1beta1/classes.rb @@ -886,8 +886,7 @@ module Google # 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" - # This field is only used by Cloud IAM. + # `paths: "bindings, etag"` # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask diff --git a/generated/google/apis/serviceconsumermanagement_v1.rb b/generated/google/apis/serviceconsumermanagement_v1.rb index 8673f420c..da0c5a7c3 100644 --- a/generated/google/apis/serviceconsumermanagement_v1.rb +++ b/generated/google/apis/serviceconsumermanagement_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/service-consumer-management/docs/overview module ServiceconsumermanagementV1 VERSION = 'V1' - REVISION = '20200329' + REVISION = '20200506' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/serviceconsumermanagement_v1/classes.rb b/generated/google/apis/serviceconsumermanagement_v1/classes.rb index 0c5f75a7d..45080bcde 100644 --- a/generated/google/apis/serviceconsumermanagement_v1/classes.rb +++ b/generated/google/apis/serviceconsumermanagement_v1/classes.rb @@ -592,21 +592,31 @@ module Google # Billing related configuration of the service. # The following example shows how to configure monitored resources and metrics - # for billing: + # for billing, `consumer_destinations` is the only supported destination and + # the monitored resources need at least one label key + # `cloud.googleapis.com/location` to indicate the location of the billing + # usage, using different monitored resources between monitoring and billing is + # recommended so they can be evolved independently: # monitored_resources: - # - type: library.googleapis.com/branch + # - type: library.googleapis.com/billing_branch # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. + # - key: cloud.googleapis.com/location + # description: | + # Predefined label to support billing location restriction. + # - key: city + # description: | + # Custom label to define the city where the library branch is located + # in. + # - key: name + # description: Custom label to define the name of the library branch. # metrics: # - name: library.googleapis.com/book/borrowed_count # metric_kind: DELTA # value_type: INT64 + # unit: "1" # billing: # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch + # - monitored_resource: library.googleapis.com/billing_branch # metrics: # - library.googleapis.com/book/borrowed_count class Billing @@ -2976,21 +2986,31 @@ module Google # Billing related configuration of the service. # The following example shows how to configure monitored resources and metrics - # for billing: + # for billing, `consumer_destinations` is the only supported destination and + # the monitored resources need at least one label key + # `cloud.googleapis.com/location` to indicate the location of the billing + # usage, using different monitored resources between monitoring and billing is + # recommended so they can be evolved independently: # monitored_resources: - # - type: library.googleapis.com/branch + # - type: library.googleapis.com/billing_branch # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. + # - key: cloud.googleapis.com/location + # description: | + # Predefined label to support billing location restriction. + # - key: city + # description: | + # Custom label to define the city where the library branch is located + # in. + # - key: name + # description: Custom label to define the name of the library branch. # metrics: # - name: library.googleapis.com/book/borrowed_count # metric_kind: DELTA # value_type: INT64 + # unit: "1" # billing: # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch + # - monitored_resource: library.googleapis.com/billing_branch # metrics: # - library.googleapis.com/book/borrowed_count # Corresponds to the JSON property `billing` diff --git a/generated/google/apis/serviceconsumermanagement_v1beta1.rb b/generated/google/apis/serviceconsumermanagement_v1beta1.rb index a8eecd8dd..89a8f192f 100644 --- a/generated/google/apis/serviceconsumermanagement_v1beta1.rb +++ b/generated/google/apis/serviceconsumermanagement_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/service-consumer-management/docs/overview module ServiceconsumermanagementV1beta1 VERSION = 'V1beta1' - REVISION = '20200329' + REVISION = '20200506' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/serviceconsumermanagement_v1beta1/classes.rb b/generated/google/apis/serviceconsumermanagement_v1beta1/classes.rb index 5527ec520..4380115d8 100644 --- a/generated/google/apis/serviceconsumermanagement_v1beta1/classes.rb +++ b/generated/google/apis/serviceconsumermanagement_v1beta1/classes.rb @@ -498,21 +498,31 @@ module Google # Billing related configuration of the service. # The following example shows how to configure monitored resources and metrics - # for billing: + # for billing, `consumer_destinations` is the only supported destination and + # the monitored resources need at least one label key + # `cloud.googleapis.com/location` to indicate the location of the billing + # usage, using different monitored resources between monitoring and billing is + # recommended so they can be evolved independently: # monitored_resources: - # - type: library.googleapis.com/branch + # - type: library.googleapis.com/billing_branch # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. + # - key: cloud.googleapis.com/location + # description: | + # Predefined label to support billing location restriction. + # - key: city + # description: | + # Custom label to define the city where the library branch is located + # in. + # - key: name + # description: Custom label to define the name of the library branch. # metrics: # - name: library.googleapis.com/book/borrowed_count # metric_kind: DELTA # value_type: INT64 + # unit: "1" # billing: # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch + # - monitored_resource: library.googleapis.com/billing_branch # metrics: # - library.googleapis.com/book/borrowed_count class Billing @@ -2682,21 +2692,31 @@ module Google # Billing related configuration of the service. # The following example shows how to configure monitored resources and metrics - # for billing: + # for billing, `consumer_destinations` is the only supported destination and + # the monitored resources need at least one label key + # `cloud.googleapis.com/location` to indicate the location of the billing + # usage, using different monitored resources between monitoring and billing is + # recommended so they can be evolved independently: # monitored_resources: - # - type: library.googleapis.com/branch + # - type: library.googleapis.com/billing_branch # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. + # - key: cloud.googleapis.com/location + # description: | + # Predefined label to support billing location restriction. + # - key: city + # description: | + # Custom label to define the city where the library branch is located + # in. + # - key: name + # description: Custom label to define the name of the library branch. # metrics: # - name: library.googleapis.com/book/borrowed_count # metric_kind: DELTA # value_type: INT64 + # unit: "1" # billing: # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch + # - monitored_resource: library.googleapis.com/billing_branch # metrics: # - library.googleapis.com/book/borrowed_count # Corresponds to the JSON property `billing` diff --git a/generated/google/apis/servicecontrol_v1.rb b/generated/google/apis/servicecontrol_v1.rb index 8ac7bde58..99a03c6ce 100644 --- a/generated/google/apis/servicecontrol_v1.rb +++ b/generated/google/apis/servicecontrol_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/service-control/ module ServicecontrolV1 VERSION = 'V1' - REVISION = '20200322' + REVISION = '20200410' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/servicedirectory_v1beta1.rb b/generated/google/apis/servicedirectory_v1beta1.rb index 60ca0cffb..d6b7e4731 100644 --- a/generated/google/apis/servicedirectory_v1beta1.rb +++ b/generated/google/apis/servicedirectory_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/service-directory module ServicedirectoryV1beta1 VERSION = 'V1beta1' - REVISION = '20200312' + REVISION = '20200415' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/servicemanagement_v1.rb b/generated/google/apis/servicemanagement_v1.rb index a182d2faf..a8d1b8c34 100644 --- a/generated/google/apis/servicemanagement_v1.rb +++ b/generated/google/apis/servicemanagement_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/service-management/ module ServicemanagementV1 VERSION = 'V1' - REVISION = '20200406' + REVISION = '20200411' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/servicemanagement_v1/service.rb b/generated/google/apis/servicemanagement_v1/service.rb index 80a3ac5a0..71f47d000 100644 --- a/generated/google/apis/servicemanagement_v1/service.rb +++ b/generated/google/apis/servicemanagement_v1/service.rb @@ -138,7 +138,12 @@ module Google end # Creates a new managed service. - # Please note one producer project can own no more than 20 services. + # A managed service is immutable, and is subject to mandatory 30-day + # data retention. You cannot move a service or recreate it within 30 days + # after deletion. + # One producer project can own no more than 500 services. For security and + # reliability purposes, a production service should be hosted in a + # dedicated producer project. # Operation # @param [Google::Apis::ServicemanagementV1::ManagedService] managed_service_object # @param [String] fields diff --git a/generated/google/apis/servicenetworking_v1.rb b/generated/google/apis/servicenetworking_v1.rb index 6f14715c3..518b1050e 100644 --- a/generated/google/apis/servicenetworking_v1.rb +++ b/generated/google/apis/servicenetworking_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started module ServicenetworkingV1 VERSION = 'V1' - REVISION = '20200408' + REVISION = '20200506' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/servicenetworking_v1/classes.rb b/generated/google/apis/servicenetworking_v1/classes.rb index 294ee5fdf..34ad09696 100644 --- a/generated/google/apis/servicenetworking_v1/classes.rb +++ b/generated/google/apis/servicenetworking_v1/classes.rb @@ -652,21 +652,31 @@ module Google # Billing related configuration of the service. # The following example shows how to configure monitored resources and metrics - # for billing: + # for billing, `consumer_destinations` is the only supported destination and + # the monitored resources need at least one label key + # `cloud.googleapis.com/location` to indicate the location of the billing + # usage, using different monitored resources between monitoring and billing is + # recommended so they can be evolved independently: # monitored_resources: - # - type: library.googleapis.com/branch + # - type: library.googleapis.com/billing_branch # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. + # - key: cloud.googleapis.com/location + # description: | + # Predefined label to support billing location restriction. + # - key: city + # description: | + # Custom label to define the city where the library branch is located + # in. + # - key: name + # description: Custom label to define the name of the library branch. # metrics: # - name: library.googleapis.com/book/borrowed_count # metric_kind: DELTA # value_type: INT64 + # unit: "1" # billing: # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch + # - monitored_resource: library.googleapis.com/billing_branch # metrics: # - library.googleapis.com/book/borrowed_count class Billing @@ -3225,21 +3235,31 @@ module Google # Billing related configuration of the service. # The following example shows how to configure monitored resources and metrics - # for billing: + # for billing, `consumer_destinations` is the only supported destination and + # the monitored resources need at least one label key + # `cloud.googleapis.com/location` to indicate the location of the billing + # usage, using different monitored resources between monitoring and billing is + # recommended so they can be evolved independently: # monitored_resources: - # - type: library.googleapis.com/branch + # - type: library.googleapis.com/billing_branch # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. + # - key: cloud.googleapis.com/location + # description: | + # Predefined label to support billing location restriction. + # - key: city + # description: | + # Custom label to define the city where the library branch is located + # in. + # - key: name + # description: Custom label to define the name of the library branch. # metrics: # - name: library.googleapis.com/book/borrowed_count # metric_kind: DELTA # value_type: INT64 + # unit: "1" # billing: # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch + # - monitored_resource: library.googleapis.com/billing_branch # metrics: # - library.googleapis.com/book/borrowed_count # Corresponds to the JSON property `billing` diff --git a/generated/google/apis/servicenetworking_v1beta.rb b/generated/google/apis/servicenetworking_v1beta.rb index db9365a81..e2073b73f 100644 --- a/generated/google/apis/servicenetworking_v1beta.rb +++ b/generated/google/apis/servicenetworking_v1beta.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started module ServicenetworkingV1beta VERSION = 'V1beta' - REVISION = '20200401' + REVISION = '20200506' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/servicenetworking_v1beta/classes.rb b/generated/google/apis/servicenetworking_v1beta/classes.rb index b8cff7894..39969f4d9 100644 --- a/generated/google/apis/servicenetworking_v1beta/classes.rb +++ b/generated/google/apis/servicenetworking_v1beta/classes.rb @@ -613,21 +613,31 @@ module Google # Billing related configuration of the service. # The following example shows how to configure monitored resources and metrics - # for billing: + # for billing, `consumer_destinations` is the only supported destination and + # the monitored resources need at least one label key + # `cloud.googleapis.com/location` to indicate the location of the billing + # usage, using different monitored resources between monitoring and billing is + # recommended so they can be evolved independently: # monitored_resources: - # - type: library.googleapis.com/branch + # - type: library.googleapis.com/billing_branch # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. + # - key: cloud.googleapis.com/location + # description: | + # Predefined label to support billing location restriction. + # - key: city + # description: | + # Custom label to define the city where the library branch is located + # in. + # - key: name + # description: Custom label to define the name of the library branch. # metrics: # - name: library.googleapis.com/book/borrowed_count # metric_kind: DELTA # value_type: INT64 + # unit: "1" # billing: # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch + # - monitored_resource: library.googleapis.com/billing_branch # metrics: # - library.googleapis.com/book/borrowed_count class Billing @@ -3029,21 +3039,31 @@ module Google # Billing related configuration of the service. # The following example shows how to configure monitored resources and metrics - # for billing: + # for billing, `consumer_destinations` is the only supported destination and + # the monitored resources need at least one label key + # `cloud.googleapis.com/location` to indicate the location of the billing + # usage, using different monitored resources between monitoring and billing is + # recommended so they can be evolved independently: # monitored_resources: - # - type: library.googleapis.com/branch + # - type: library.googleapis.com/billing_branch # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. + # - key: cloud.googleapis.com/location + # description: | + # Predefined label to support billing location restriction. + # - key: city + # description: | + # Custom label to define the city where the library branch is located + # in. + # - key: name + # description: Custom label to define the name of the library branch. # metrics: # - name: library.googleapis.com/book/borrowed_count # metric_kind: DELTA # value_type: INT64 + # unit: "1" # billing: # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch + # - monitored_resource: library.googleapis.com/billing_branch # metrics: # - library.googleapis.com/book/borrowed_count # Corresponds to the JSON property `billing` diff --git a/generated/google/apis/serviceusage_v1.rb b/generated/google/apis/serviceusage_v1.rb index 26a962d77..04a339e2c 100644 --- a/generated/google/apis/serviceusage_v1.rb +++ b/generated/google/apis/serviceusage_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/service-usage/ module ServiceusageV1 VERSION = 'V1' - REVISION = '20200331' + REVISION = '20200506' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/serviceusage_v1/classes.rb b/generated/google/apis/serviceusage_v1/classes.rb index 3e0612dbf..8ae51f915 100644 --- a/generated/google/apis/serviceusage_v1/classes.rb +++ b/generated/google/apis/serviceusage_v1/classes.rb @@ -609,21 +609,31 @@ module Google # Billing related configuration of the service. # The following example shows how to configure monitored resources and metrics - # for billing: + # for billing, `consumer_destinations` is the only supported destination and + # the monitored resources need at least one label key + # `cloud.googleapis.com/location` to indicate the location of the billing + # usage, using different monitored resources between monitoring and billing is + # recommended so they can be evolved independently: # monitored_resources: - # - type: library.googleapis.com/branch + # - type: library.googleapis.com/billing_branch # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. + # - key: cloud.googleapis.com/location + # description: | + # Predefined label to support billing location restriction. + # - key: city + # description: | + # Custom label to define the city where the library branch is located + # in. + # - key: name + # description: Custom label to define the name of the library branch. # metrics: # - name: library.googleapis.com/book/borrowed_count # metric_kind: DELTA # value_type: INT64 + # unit: "1" # billing: # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch + # - monitored_resource: library.googleapis.com/billing_branch # metrics: # - library.googleapis.com/book/borrowed_count class Billing @@ -1467,21 +1477,31 @@ module Google # Billing related configuration of the service. # The following example shows how to configure monitored resources and metrics - # for billing: + # for billing, `consumer_destinations` is the only supported destination and + # the monitored resources need at least one label key + # `cloud.googleapis.com/location` to indicate the location of the billing + # usage, using different monitored resources between monitoring and billing is + # recommended so they can be evolved independently: # monitored_resources: - # - type: library.googleapis.com/branch + # - type: library.googleapis.com/billing_branch # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. + # - key: cloud.googleapis.com/location + # description: | + # Predefined label to support billing location restriction. + # - key: city + # description: | + # Custom label to define the city where the library branch is located + # in. + # - key: name + # description: Custom label to define the name of the library branch. # metrics: # - name: library.googleapis.com/book/borrowed_count # metric_kind: DELTA # value_type: INT64 + # unit: "1" # billing: # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch + # - monitored_resource: library.googleapis.com/billing_branch # metrics: # - library.googleapis.com/book/borrowed_count # Corresponds to the JSON property `billing` diff --git a/generated/google/apis/serviceusage_v1/service.rb b/generated/google/apis/serviceusage_v1/service.rb index 38dc7c046..daa72bad8 100644 --- a/generated/google/apis/serviceusage_v1/service.rb +++ b/generated/google/apis/serviceusage_v1/service.rb @@ -254,7 +254,7 @@ module Google # An example name would be: # `projects/123/services/serviceusage.googleapis.com` where `123` is the # project number. - # A single request can get a maximum of 20 services at a time. + # A single request can get a maximum of 30 services at a time. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/serviceusage_v1beta1.rb b/generated/google/apis/serviceusage_v1beta1.rb index 2acd337d7..ba94d4e79 100644 --- a/generated/google/apis/serviceusage_v1beta1.rb +++ b/generated/google/apis/serviceusage_v1beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/service-usage/ module ServiceusageV1beta1 VERSION = 'V1beta1' - REVISION = '20200331' + REVISION = '20200506' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/serviceusage_v1beta1/classes.rb b/generated/google/apis/serviceusage_v1beta1/classes.rb index eb5e0ce12..e610ffe98 100644 --- a/generated/google/apis/serviceusage_v1beta1/classes.rb +++ b/generated/google/apis/serviceusage_v1beta1/classes.rb @@ -592,21 +592,31 @@ module Google # Billing related configuration of the service. # The following example shows how to configure monitored resources and metrics - # for billing: + # for billing, `consumer_destinations` is the only supported destination and + # the monitored resources need at least one label key + # `cloud.googleapis.com/location` to indicate the location of the billing + # usage, using different monitored resources between monitoring and billing is + # recommended so they can be evolved independently: # monitored_resources: - # - type: library.googleapis.com/branch + # - type: library.googleapis.com/billing_branch # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. + # - key: cloud.googleapis.com/location + # description: | + # Predefined label to support billing location restriction. + # - key: city + # description: | + # Custom label to define the city where the library branch is located + # in. + # - key: name + # description: Custom label to define the name of the library branch. # metrics: # - name: library.googleapis.com/book/borrowed_count # metric_kind: DELTA # value_type: INT64 + # unit: "1" # billing: # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch + # - monitored_resource: library.googleapis.com/billing_branch # metrics: # - library.googleapis.com/book/borrowed_count class Billing @@ -1536,21 +1546,31 @@ module Google # Billing related configuration of the service. # The following example shows how to configure monitored resources and metrics - # for billing: + # for billing, `consumer_destinations` is the only supported destination and + # the monitored resources need at least one label key + # `cloud.googleapis.com/location` to indicate the location of the billing + # usage, using different monitored resources between monitoring and billing is + # recommended so they can be evolved independently: # monitored_resources: - # - type: library.googleapis.com/branch + # - type: library.googleapis.com/billing_branch # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. + # - key: cloud.googleapis.com/location + # description: | + # Predefined label to support billing location restriction. + # - key: city + # description: | + # Custom label to define the city where the library branch is located + # in. + # - key: name + # description: Custom label to define the name of the library branch. # metrics: # - name: library.googleapis.com/book/borrowed_count # metric_kind: DELTA # value_type: INT64 + # unit: "1" # billing: # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch + # - monitored_resource: library.googleapis.com/billing_branch # metrics: # - library.googleapis.com/book/borrowed_count # Corresponds to the JSON property `billing` diff --git a/generated/google/apis/sheets_v4.rb b/generated/google/apis/sheets_v4.rb index e66031ef3..c0bd53033 100644 --- a/generated/google/apis/sheets_v4.rb +++ b/generated/google/apis/sheets_v4.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/sheets/ module SheetsV4 VERSION = 'V4' - REVISION = '20200312' + REVISION = '20200424' # See, edit, create, and delete all of your Google Drive files AUTH_DRIVE = 'https://www.googleapis.com/auth/drive' diff --git a/generated/google/apis/sheets_v4/classes.rb b/generated/google/apis/sheets_v4/classes.rb index bd925e3ad..c11d4fefc 100644 --- a/generated/google/apis/sheets_v4/classes.rb +++ b/generated/google/apis/sheets_v4/classes.rb @@ -7341,8 +7341,8 @@ module Google # The column offset of the source range that this grouping is based on. # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` - # means this group refers to column `C`, whereas the offset `1` would refer - # to column `D`. + # means this group refers to column `C`, whereas the offset `1` would + # refer to column `D`. # Corresponds to the JSON property `sourceColumnOffset` # @return [Fixnum] attr_accessor :source_column_offset diff --git a/generated/google/apis/sourcerepo_v1.rb b/generated/google/apis/sourcerepo_v1.rb index 4ef478efc..c88732263 100644 --- a/generated/google/apis/sourcerepo_v1.rb +++ b/generated/google/apis/sourcerepo_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/source-repositories/docs/apis module SourcerepoV1 VERSION = 'V1' - REVISION = '20200121' + REVISION = '20200415' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/sourcerepo_v1/classes.rb b/generated/google/apis/sourcerepo_v1/classes.rb index d7415fdab..9251a6130 100644 --- a/generated/google/apis/sourcerepo_v1/classes.rb +++ b/generated/google/apis/sourcerepo_v1/classes.rb @@ -737,8 +737,7 @@ module Google # 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" - # This field is only used by Cloud IAM. + # `paths: "bindings, etag"` # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask diff --git a/generated/google/apis/speech_v1.rb b/generated/google/apis/speech_v1.rb index a95da2f80..8eb59445e 100644 --- a/generated/google/apis/speech_v1.rb +++ b/generated/google/apis/speech_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/speech-to-text/docs/quickstart-protocol module SpeechV1 VERSION = 'V1' - REVISION = '20200406' + REVISION = '20200409' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/speech_v1/classes.rb b/generated/google/apis/speech_v1/classes.rb index c8a96b3a0..d0f5dd535 100644 --- a/generated/google/apis/speech_v1/classes.rb +++ b/generated/google/apis/speech_v1/classes.rb @@ -69,7 +69,8 @@ module Google # @return [String] attr_accessor :start_time - # The URI of the audio file being transcribed. Empty if the audio was sent + # Output only. The URI of the audio file being transcribed. Empty if the audio + # was sent # as byte content. # Corresponds to the JSON property `uri` # @return [String] diff --git a/generated/google/apis/speech_v1p1beta1.rb b/generated/google/apis/speech_v1p1beta1.rb index 41e3b5c96..114e9efc5 100644 --- a/generated/google/apis/speech_v1p1beta1.rb +++ b/generated/google/apis/speech_v1p1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/speech-to-text/docs/quickstart-protocol module SpeechV1p1beta1 VERSION = 'V1p1beta1' - REVISION = '20200406' + REVISION = '20200502' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/speech_v1p1beta1/classes.rb b/generated/google/apis/speech_v1p1beta1/classes.rb index 0913bec22..c8382b63c 100644 --- a/generated/google/apis/speech_v1p1beta1/classes.rb +++ b/generated/google/apis/speech_v1p1beta1/classes.rb @@ -22,6 +22,59 @@ module Google module Apis module SpeechV1p1beta1 + # An item of the class. + class ClassItem + include Google::Apis::Core::Hashable + + # The class item's value. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @value = args[:value] if args.key?(:value) + end + end + + # A set of words or phrases that represents a common concept likely to appear + # in your audio, for example a list of passenger ship names. CustomClass items + # can be substituted into placeholders that you set in PhraseSet phrases. + class CustomClass + include Google::Apis::Core::Hashable + + # If this custom class is a resource, the custom_class_id is the resource id + # of the CustomClass. Case sensitive. + # Corresponds to the JSON property `customClassId` + # @return [String] + attr_accessor :custom_class_id + + # A collection of class items. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # The resource name of the custom class. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @custom_class_id = args[:custom_class_id] if args.key?(:custom_class_id) + @items = args[:items] if args.key?(:items) + @name = args[:name] if args.key?(:name) + end + end + # The response message for Operations.ListOperations. class ListOperationsResponse include Google::Apis::Core::Hashable @@ -69,7 +122,8 @@ module Google # @return [String] attr_accessor :start_time - # The URI of the audio file being transcribed. Empty if the audio was sent + # Output only. The URI of the audio file being transcribed. Empty if the audio + # was sent # as byte content. # Corresponds to the JSON property `uri` # @return [String] @@ -206,6 +260,97 @@ module Google end end + # A phrases containing words and phrase "hints" so that + # the speech recognition is more likely to recognize them. This can be used + # to improve the accuracy for specific words and phrases, for example, if + # specific commands are typically spoken by the user. This can also be used + # to add additional words to the vocabulary of the recognizer. See + # [usage limits](https://cloud.google.com/speech-to-text/quotas#content). + # List items can also include pre-built or custom classes containing groups + # of words that represent common concepts that occur in natural language. For + # example, rather than providing a phrase hint for every month of the + # year (e.g. "i was born in january", "i was born in febuary", ...), use the + # pre-built `$MONTH` class improves the likelihood of correctly transcribing + # audio that includes months (e.g. "i was born in $month"). + # To refer to pre-built classes, use the class' symbol prepended with `$` + # e.g. `$MONTH`. To refer to custom classes that were defined inline in the + # request, set the class's `custom_class_id` to a string unique to all class + # resources and inline classes. Then use the class' id wrapped in $``...`` + # e.g. "$`my-months`". To refer to custom classes resources, use the class' + # id wrapped in `$``` (e.g. `$`my-months``). + class Phrase + include Google::Apis::Core::Hashable + + # Hint Boost. Overrides the boost set at the phrase set level. + # Positive value will increase the probability that a specific phrase will + # be recognized over other similar sounding phrases. The higher the boost, + # the higher the chance of false positive recognition as well. Negative + # boost values would correspond to anti-biasing. Anti-biasing is not + # enabled, so negative boost will simply be ignored. Though `boost` can + # accept a wide range of positive values, most use cases are best served + # with values between 0 and 20. We recommend using a binary search approach + # to finding the optimal value for your use case. Speech recognition + # will skip PhraseSets with a boost value of 0. + # Corresponds to the JSON property `boost` + # @return [Float] + attr_accessor :boost + + # The phrase itself. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @boost = args[:boost] if args.key?(:boost) + @value = args[:value] if args.key?(:value) + end + end + + # Provides "hints" to the speech recognizer to favor specific words and phrases + # in the results. + class PhraseSet + include Google::Apis::Core::Hashable + + # Hint Boost. Positive value will increase the probability that a specific + # phrase will be recognized over other similar sounding phrases. The higher + # the boost, the higher the chance of false positive recognition as well. + # Negative boost values would correspond to anti-biasing. Anti-biasing is not + # enabled, so negative boost will simply be ignored. Though `boost` can + # accept a wide range of positive values, most use cases are best served with + # values between 0 (exclusive) and 20. We recommend using a binary search + # approach to finding the optimal value for your use case. Speech recognition + # will skip PhraseSets with a boost value of 0. + # Corresponds to the JSON property `boost` + # @return [Float] + attr_accessor :boost + + # The resource name of the phrase set. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # A list of word and phrases. + # Corresponds to the JSON property `phrases` + # @return [Array] + attr_accessor :phrases + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @boost = args[:boost] if args.key?(:boost) + @name = args[:name] if args.key?(:name) + @phrases = args[:phrases] if args.key?(:phrases) + end + end + # Contains audio data in the encoding specified in the `RecognitionConfig`. # Either `content` or `uri` must be supplied. Supplying both or neither # returns google.rpc.Code.INVALID_ARGUMENT. See @@ -248,6 +393,11 @@ module Google class RecognitionConfig include Google::Apis::Core::Hashable + # Speech adaptation configuration. + # Corresponds to the JSON property `adaptation` + # @return [Google::Apis::SpeechV1p1beta1::SpeechAdaptation] + attr_accessor :adaptation + # A list of up to 3 additional # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags, # listing possible alternative languages of the supplied audio. @@ -450,6 +600,7 @@ module Google # Update properties of this object def update!(**args) + @adaptation = args[:adaptation] if args.key?(:adaptation) @alternative_language_codes = args[:alternative_language_codes] if args.key?(:alternative_language_codes) @audio_channel_count = args[:audio_channel_count] if args.key?(:audio_channel_count) @diarization_config = args[:diarization_config] if args.key?(:diarization_config) @@ -643,6 +794,36 @@ module Google end end + # Speech adaptation configuration. + class SpeechAdaptation + include Google::Apis::Core::Hashable + + # A collection of custom classes. To specify the classes inline, leave the + # class' `name` blank and fill in the rest of its fields, giving it a unique + # `custom_class_id`. Refer to the inline defined class in phrase hints by its + # `custom_class_id`. + # Corresponds to the JSON property `customClasses` + # @return [Array] + attr_accessor :custom_classes + + # A collection of phrase sets. To specify the hints inline, leave the + # phrase set's `name` blank and fill in the rest of its fields. Any + # phrase set can use any custom class. + # Corresponds to the JSON property `phraseSets` + # @return [Array] + attr_accessor :phrase_sets + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @custom_classes = args[:custom_classes] if args.key?(:custom_classes) + @phrase_sets = args[:phrase_sets] if args.key?(:phrase_sets) + end + end + # Provides "hints" to the speech recognizer to favor specific words and phrases # in the results. class SpeechContext diff --git a/generated/google/apis/speech_v1p1beta1/representations.rb b/generated/google/apis/speech_v1p1beta1/representations.rb index 4de7848ac..efbacaf0d 100644 --- a/generated/google/apis/speech_v1p1beta1/representations.rb +++ b/generated/google/apis/speech_v1p1beta1/representations.rb @@ -22,6 +22,18 @@ module Google module Apis module SpeechV1p1beta1 + class ClassItem + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomClass + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ListOperationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -52,6 +64,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Phrase + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PhraseSet + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class RecognitionAudio class Representation < Google::Apis::Core::JsonRepresentation; end @@ -88,6 +112,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class SpeechAdaptation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SpeechContext class Representation < Google::Apis::Core::JsonRepresentation; end @@ -118,6 +148,23 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ClassItem + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :value, as: 'value' + end + end + + class CustomClass + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :custom_class_id, as: 'customClassId' + collection :items, as: 'items', class: Google::Apis::SpeechV1p1beta1::ClassItem, decorator: Google::Apis::SpeechV1p1beta1::ClassItem::Representation + + property :name, as: 'name' + end + end + class ListOperationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -167,6 +214,24 @@ module Google end end + class Phrase + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :boost, as: 'boost' + property :value, as: 'value' + end + end + + class PhraseSet + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :boost, as: 'boost' + property :name, as: 'name' + collection :phrases, as: 'phrases', class: Google::Apis::SpeechV1p1beta1::Phrase, decorator: Google::Apis::SpeechV1p1beta1::Phrase::Representation + + end + end + class RecognitionAudio # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -178,6 +243,8 @@ module Google class RecognitionConfig # @private class Representation < Google::Apis::Core::JsonRepresentation + property :adaptation, as: 'adaptation', class: Google::Apis::SpeechV1p1beta1::SpeechAdaptation, decorator: Google::Apis::SpeechV1p1beta1::SpeechAdaptation::Representation + collection :alternative_language_codes, as: 'alternativeLanguageCodes' property :audio_channel_count, as: 'audioChannelCount' property :diarization_config, as: 'diarizationConfig', class: Google::Apis::SpeechV1p1beta1::SpeakerDiarizationConfig, decorator: Google::Apis::SpeechV1p1beta1::SpeakerDiarizationConfig::Representation @@ -245,6 +312,16 @@ module Google end end + class SpeechAdaptation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :custom_classes, as: 'customClasses', class: Google::Apis::SpeechV1p1beta1::CustomClass, decorator: Google::Apis::SpeechV1p1beta1::CustomClass::Representation + + collection :phrase_sets, as: 'phraseSets', class: Google::Apis::SpeechV1p1beta1::PhraseSet, decorator: Google::Apis::SpeechV1p1beta1::PhraseSet::Representation + + end + end + class SpeechContext # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/storage_v1.rb b/generated/google/apis/storage_v1.rb index 7fd71e21e..2938ee207 100644 --- a/generated/google/apis/storage_v1.rb +++ b/generated/google/apis/storage_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/storage/docs/json_api/ module StorageV1 VERSION = 'V1' - REVISION = '20200326' + REVISION = '20200410' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/storage_v1/classes.rb b/generated/google/apis/storage_v1/classes.rb index 2266422a2..8348e9523 100644 --- a/generated/google/apis/storage_v1/classes.rb +++ b/generated/google/apis/storage_v1/classes.rb @@ -499,6 +499,19 @@ module Google # @return [Date] attr_accessor :created_before + # A timestamp in RFC 3339 format. This condition is satisfied when the custom + # time on an object is before this timestamp. + # Corresponds to the JSON property `customTimeBefore` + # @return [DateTime] + attr_accessor :custom_time_before + + # Number of days elapsed since the user-specified timestamp set on an object. + # The condition is satisfied if the days elapsed is at least this number. If no + # custom timestamp is specified on an object, the condition does not apply. + # Corresponds to the JSON property `daysSinceCustomTime` + # @return [Fixnum] + attr_accessor :days_since_custom_time + # Relevant only for versioned objects. If the value is true, this condition # matches live objects; if the value is false, it matches archived objects. # Corresponds to the JSON property `isLive` @@ -537,6 +550,8 @@ module Google def update!(**args) @age = args[:age] if args.key?(:age) @created_before = args[:created_before] if args.key?(:created_before) + @custom_time_before = args[:custom_time_before] if args.key?(:custom_time_before) + @days_since_custom_time = args[:days_since_custom_time] if args.key?(:days_since_custom_time) @is_live = args[:is_live] if args.key?(:is_live) @matches_pattern = args[:matches_pattern] if args.key?(:matches_pattern) @matches_storage_class = args[:matches_storage_class] if args.key?(:matches_storage_class) @@ -1364,6 +1379,11 @@ module Google # @return [String] attr_accessor :crc32c + # A timestamp in RFC 3339 format specified by the user for an object. + # Corresponds to the JSON property `customTime` + # @return [DateTime] + attr_accessor :custom_time + # Metadata of customer-supplied encryption key, if the object is encrypted by # such a key. # Corresponds to the JSON property `customerEncryption` @@ -1519,6 +1539,7 @@ module Google @content_language = args[:content_language] if args.key?(:content_language) @content_type = args[:content_type] if args.key?(:content_type) @crc32c = args[:crc32c] if args.key?(:crc32c) + @custom_time = args[:custom_time] if args.key?(:custom_time) @customer_encryption = args[:customer_encryption] if args.key?(:customer_encryption) @etag = args[:etag] if args.key?(:etag) @event_based_hold = args[:event_based_hold] if args.key?(:event_based_hold) diff --git a/generated/google/apis/storage_v1/representations.rb b/generated/google/apis/storage_v1/representations.rb index 2cefa9142..a774c0966 100644 --- a/generated/google/apis/storage_v1/representations.rb +++ b/generated/google/apis/storage_v1/representations.rb @@ -403,6 +403,9 @@ module Google property :age, as: 'age' property :created_before, as: 'createdBefore', type: Date + property :custom_time_before, as: 'customTimeBefore', type: DateTime + + property :days_since_custom_time, as: 'daysSinceCustomTime' property :is_live, as: 'isLive' property :matches_pattern, as: 'matchesPattern' collection :matches_storage_class, as: 'matchesStorageClass' @@ -628,6 +631,8 @@ module Google property :content_language, as: 'contentLanguage' property :content_type, as: 'contentType' property :crc32c, as: 'crc32c' + property :custom_time, as: 'customTime', type: DateTime + property :customer_encryption, as: 'customerEncryption', class: Google::Apis::StorageV1::Object::CustomerEncryption, decorator: Google::Apis::StorageV1::Object::CustomerEncryption::Representation property :etag, as: 'etag' diff --git a/generated/google/apis/tagmanager_v1.rb b/generated/google/apis/tagmanager_v1.rb index 6bad3e5b9..90f74a248 100644 --- a/generated/google/apis/tagmanager_v1.rb +++ b/generated/google/apis/tagmanager_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/tag-manager module TagmanagerV1 VERSION = 'V1' - REVISION = '20200220' + REVISION = '20200504' # Delete your Google Tag Manager containers AUTH_TAGMANAGER_DELETE_CONTAINERS = 'https://www.googleapis.com/auth/tagmanager.delete.containers' diff --git a/generated/google/apis/tagmanager_v1/service.rb b/generated/google/apis/tagmanager_v1/service.rb index f53311dd2..22797467e 100644 --- a/generated/google/apis/tagmanager_v1/service.rb +++ b/generated/google/apis/tagmanager_v1/service.rb @@ -45,7 +45,7 @@ module Google def initialize super('https://www.googleapis.com/', '') - @batch_path = 'batch' + @batch_path = 'batch/tagmanager/v1' end # Gets a GTM Account. diff --git a/generated/google/apis/tagmanager_v2.rb b/generated/google/apis/tagmanager_v2.rb index 4acae46ea..3847a88ad 100644 --- a/generated/google/apis/tagmanager_v2.rb +++ b/generated/google/apis/tagmanager_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/tag-manager module TagmanagerV2 VERSION = 'V2' - REVISION = '20200220' + REVISION = '20200504' # Delete your Google Tag Manager containers AUTH_TAGMANAGER_DELETE_CONTAINERS = 'https://www.googleapis.com/auth/tagmanager.delete.containers' diff --git a/generated/google/apis/tagmanager_v2/service.rb b/generated/google/apis/tagmanager_v2/service.rb index 63eba7df9..ea9f3a9c0 100644 --- a/generated/google/apis/tagmanager_v2/service.rb +++ b/generated/google/apis/tagmanager_v2/service.rb @@ -45,7 +45,7 @@ module Google def initialize super('https://www.googleapis.com/', '') - @batch_path = 'batch' + @batch_path = 'batch/tagmanager/v2' end # Gets a GTM Account. diff --git a/generated/google/apis/testing_v1.rb b/generated/google/apis/testing_v1.rb index 8f51d4f1f..9ef6cc2d1 100644 --- a/generated/google/apis/testing_v1.rb +++ b/generated/google/apis/testing_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/cloud-test-lab/ module TestingV1 VERSION = 'V1' - REVISION = '20200226' + REVISION = '20200429' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/testing_v1/classes.rb b/generated/google/apis/testing_v1/classes.rb index 1669e5475..425c32cc7 100644 --- a/generated/google/apis/testing_v1/classes.rb +++ b/generated/google/apis/testing_v1/classes.rb @@ -1425,6 +1425,14 @@ module Google # @return [String] attr_accessor :app_bundle_id + # The option to test special app entitlements. Setting this would re-sign the + # app having special entitlements with an explicit application-identifier. + # Currently supports testing aps-environment entitlement. + # Corresponds to the JSON property `testSpecialEntitlements` + # @return [Boolean] + attr_accessor :test_special_entitlements + alias_method :test_special_entitlements?, :test_special_entitlements + # A reference to a file, used for user inputs. # Corresponds to the JSON property `testsZip` # @return [Google::Apis::TestingV1::FileReference] @@ -1449,6 +1457,7 @@ module Google # Update properties of this object def update!(**args) @app_bundle_id = args[:app_bundle_id] if args.key?(:app_bundle_id) + @test_special_entitlements = args[:test_special_entitlements] if args.key?(:test_special_entitlements) @tests_zip = args[:tests_zip] if args.key?(:tests_zip) @xcode_version = args[:xcode_version] if args.key?(:xcode_version) @xctestrun = args[:xctestrun] if args.key?(:xctestrun) diff --git a/generated/google/apis/testing_v1/representations.rb b/generated/google/apis/testing_v1/representations.rb index ba8bce01e..2ac248de0 100644 --- a/generated/google/apis/testing_v1/representations.rb +++ b/generated/google/apis/testing_v1/representations.rb @@ -815,6 +815,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :app_bundle_id, as: 'appBundleId' + property :test_special_entitlements, as: 'testSpecialEntitlements' property :tests_zip, as: 'testsZip', class: Google::Apis::TestingV1::FileReference, decorator: Google::Apis::TestingV1::FileReference::Representation property :xcode_version, as: 'xcodeVersion' diff --git a/generated/google/apis/toolresults_v1beta3.rb b/generated/google/apis/toolresults_v1beta3.rb index 7130d2a8a..c48e96269 100644 --- a/generated/google/apis/toolresults_v1beta3.rb +++ b/generated/google/apis/toolresults_v1beta3.rb @@ -20,12 +20,12 @@ module Google module Apis # Cloud Tool Results API # - # Reads and publishes results from Firebase Test Lab. + # API to publish and access results from developer tools. # # @see https://firebase.google.com/docs/test-lab/ module ToolresultsV1beta3 VERSION = 'V1beta3' - REVISION = '20200317' + REVISION = '20200430' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/toolresults_v1beta3/classes.rb b/generated/google/apis/toolresults_v1beta3/classes.rb index 316ec9fdf..e56bf75de 100644 --- a/generated/google/apis/toolresults_v1beta3/classes.rb +++ b/generated/google/apis/toolresults_v1beta3/classes.rb @@ -22,26 +22,49 @@ module Google module Apis module ToolresultsV1beta3 + # Additional details for an ANR crash. + class Anr + include Google::Apis::Core::Hashable + + # A stacktrace. + # Corresponds to the JSON property `stackTrace` + # @return [Google::Apis::ToolresultsV1beta3::StackTrace] + attr_accessor :stack_trace + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @stack_trace = args[:stack_trace] if args.key?(:stack_trace) + end + end + # Android app information. class AndroidAppInfo include Google::Apis::Core::Hashable - # The name of the app. Optional + # The name of the app. + # Optional # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The package name of the app. Required. + # The package name of the app. + # Required. # Corresponds to the JSON property `packageName` # @return [String] attr_accessor :package_name - # The internal version code of the app. Optional. + # The internal version code of the app. + # Optional. # Corresponds to the JSON property `versionCode` # @return [String] attr_accessor :version_code - # The version name of the app. Optional. + # The version name of the app. + # Optional. # Corresponds to the JSON property `versionName` # @return [String] attr_accessor :version_name @@ -61,30 +84,35 @@ module Google # A test of an Android application that can control an Android component # independently of its normal lifecycle. - # See for more information on types of Android tests. + # See for + # more information on types of Android tests. class AndroidInstrumentationTest include Google::Apis::Core::Hashable - # The java package for the test to be executed. Required + # The java package for the test to be executed. + # Required # Corresponds to the JSON property `testPackageId` # @return [String] attr_accessor :test_package_id - # The InstrumentationTestRunner class. Required + # The InstrumentationTestRunner class. + # Required # Corresponds to the JSON property `testRunnerClass` # @return [String] attr_accessor :test_runner_class - # Each target must be fully qualified with the package name or class name, in - # one of these formats: - "package package_name" - "class package_name. - # class_name" - "class package_name.class_name#method_name" + # Each target must be fully qualified with the package name or class name, + # in one of these formats: + # - "package package_name" + # - "class package_name.class_name" + # - "class package_name.class_name#method_name" # If empty, all targets in the module will be run. # Corresponds to the JSON property `testTargets` # @return [Array] attr_accessor :test_targets - # The flag indicates whether Android Test Orchestrator will be used to run test - # or not. + # The flag indicates whether Android Test Orchestrator will be used to run + # test or not. # Corresponds to the JSON property `useOrchestrator` # @return [Boolean] attr_accessor :use_orchestrator @@ -103,32 +131,37 @@ module Google end end - # A test of an android application that explores the application on a virtual or - # physical Android device, finding culprits and crashes as it goes. + # A test of an android application that explores the application on a virtual + # or physical Android device, finding culprits and crashes as it goes. class AndroidRoboTest include Google::Apis::Core::Hashable - # The initial activity that should be used to start the app. Optional + # The initial activity that should be used to start the app. + # Optional # Corresponds to the JSON property `appInitialActivity` # @return [String] attr_accessor :app_initial_activity - # The java package for the bootstrap. Optional + # The java package for the bootstrap. + # Optional # Corresponds to the JSON property `bootstrapPackageId` # @return [String] attr_accessor :bootstrap_package_id - # The runner class for the bootstrap. Optional + # The runner class for the bootstrap. + # Optional # Corresponds to the JSON property `bootstrapRunnerClass` # @return [String] attr_accessor :bootstrap_runner_class - # The max depth of the traversal stack Robo can explore. Optional + # The max depth of the traversal stack Robo can explore. + # Optional # Corresponds to the JSON property `maxDepth` # @return [Fixnum] attr_accessor :max_depth - # The max number of steps/actions Robo can execute. Default is no limit (0). + # The max number of steps/actions Robo can execute. + # Default is no limit (0). # Optional # Corresponds to the JSON property `maxSteps` # @return [Fixnum] @@ -159,47 +192,30 @@ module Google # A test of an Android application that can control an Android component # independently of its normal lifecycle. - # See for more information on types of Android tests. + # See for + # more information on types of Android tests. # Corresponds to the JSON property `androidInstrumentationTest` # @return [Google::Apis::ToolresultsV1beta3::AndroidInstrumentationTest] attr_accessor :android_instrumentation_test - # A test of an android application that explores the application on a virtual or - # physical Android device, finding culprits and crashes as it goes. + # A test of an android application that explores the application on a virtual + # or physical Android device, finding culprits and crashes as it goes. # Corresponds to the JSON property `androidRoboTest` # @return [Google::Apis::ToolresultsV1beta3::AndroidRoboTest] attr_accessor :android_robo_test - # A Duration represents a signed, fixed-length span of time represented as a - # count of seconds and fractions of seconds at nanosecond resolution. It is - # independent of any calendar and concepts like "day" or "month". It is related - # to Timestamp in that the difference between two Timestamp values is a Duration - # and it can be added or subtracted from a Timestamp. Range is approximately +- - # 10,000 years. - # # Examples - # Example 1: Compute Duration from two Timestamps in pseudo code. - # Timestamp start = ...; Timestamp end = ...; Duration duration = ...; - # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - - # start.nanos; - # if (duration.seconds 0) ` duration.seconds += 1; duration.nanos -= 1000000000; - # ` else if (duration.seconds > 0 && duration.nanos < 0) ` duration.seconds -= - # 1; duration.nanos += 1000000000; ` - # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. - # Timestamp start = ...; Duration duration = ...; Timestamp end = ...; - # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + - # duration.nanos; - # if (end.nanos = 1000000000) ` end.seconds += 1; end.nanos -= 1000000000; ` - # Example 3: Compute Duration from datetime.timedelta in Python. - # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration. - # FromTimedelta(td) - # # JSON Mapping - # In JSON format, the Duration type is encoded as a string rather than an object, - # where the string ends in the suffix "s" (indicating seconds) and is preceded - # by the number of seconds, with nanoseconds expressed as fractional seconds. - # For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as " - # 3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3. - # 000000001s", and 3 seconds and 1 microsecond should be expressed in JSON - # format as "3.000001s". + # Test Loops are tests that can be launched by the app itself, determining + # when to run by listening for an intent. go/ftl-games-dd + # Corresponds to the JSON property `androidTestLoop` + # @return [Google::Apis::ToolresultsV1beta3::AndroidTestLoop] + attr_accessor :android_test_loop + + # A Duration represents a signed, fixed-length span of time represented + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". It is related to Timestamp in that the difference between + # two Timestamp values is a Duration and it can be added or subtracted + # from a Timestamp. Range is approximately +-10,000 years. # Corresponds to the JSON property `testTimeout` # @return [Google::Apis::ToolresultsV1beta3::Duration] attr_accessor :test_timeout @@ -213,63 +229,113 @@ module Google @android_app_info = args[:android_app_info] if args.key?(:android_app_info) @android_instrumentation_test = args[:android_instrumentation_test] if args.key?(:android_instrumentation_test) @android_robo_test = args[:android_robo_test] if args.key?(:android_robo_test) + @android_test_loop = args[:android_test_loop] if args.key?(:android_test_loop) @test_timeout = args[:test_timeout] if args.key?(:test_timeout) end end + # Test Loops are tests that can be launched by the app itself, determining + # when to run by listening for an intent. go/ftl-games-dd + class AndroidTestLoop + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + # `Any` contains an arbitrary serialized protocol buffer message along with a # URL that describes the type of the serialized message. - # Protobuf library provides support to pack/unpack Any values in the form of - # utility functions or additional generated methods of the Any type. + # Protobuf library provides support to pack/unpack Any values in the form + # of utility functions or additional generated methods of the Any type. # Example 1: Pack and unpack a message in C++. - # Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) ` ... ` + # Foo foo = ...; + # Any any; + # any.PackFrom(foo); + # ... + # if (any.UnpackTo(&foo)) ` + # ... + # ` # Example 2: Pack and unpack a message in Java. - # Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) ` foo = any. - # unpack(Foo.class); ` + # Foo foo = ...; + # Any any = Any.pack(foo); + # ... + # if (any.is(Foo.class)) ` + # foo = any.unpack(Foo.class); + # ` # Example 3: Pack and unpack a message in Python. - # foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any. - # Unpack(foo) ... + # foo = Foo(...) + # any = Any() + # any.Pack(foo) + # ... + # if any.Is(Foo.DESCRIPTOR): + # any.Unpack(foo) + # ... # Example 4: Pack and unpack a message in Go - # foo := &pb.Foo`...` any, err := ptypes.MarshalAny(foo) ... foo := &pb.Foo`` if - # err := ptypes.UnmarshalAny(any, foo); err != nil ` ... ` - # The pack methods provided by protobuf library will by default use 'type. - # googleapis.com/full.type.name' as the type URL and the unpack methods only use - # the fully qualified type name after the last '/' in the type URL, for example " - # foo.bar.com/x/y.z" will yield type name "y.z". - # JSON ==== The JSON representation of an `Any` value uses the regular - # representation of the deserialized, embedded message, with an additional field - # `@type` which contains the type URL. Example: - # package google.profile; message Person ` string first_name = 1; string - # last_name = 2; ` - # ` "@type": "type.googleapis.com/google.profile.Person", "firstName": , " - # lastName": ` + # foo := &pb.Foo`...` + # any, err := ptypes.MarshalAny(foo) + # ... + # foo := &pb.Foo`` + # if err := ptypes.UnmarshalAny(any, foo); err != nil ` + # ... + # ` + # The pack methods provided by protobuf library will by default use + # 'type.googleapis.com/full.type.name' as the type URL and the unpack + # methods only use the fully qualified type name after the last '/' + # in the type URL, for example "foo.bar.com/x/y.z" will yield type + # name "y.z". + # # JSON + # The JSON representation of an `Any` value uses the regular + # representation of the deserialized, embedded message, with an + # additional field `@type` which contains the type URL. Example: + # package google.profile; + # message Person ` + # string first_name = 1; + # string last_name = 2; + # ` + # ` + # "@type": "type.googleapis.com/google.profile.Person", + # "firstName": , + # "lastName": + # ` # If the embedded message type is well-known and has a custom JSON - # representation, that representation will be embedded adding a field `value` - # which holds the custom JSON in addition to the `@type` field. Example (for - # message [google.protobuf.Duration][]): - # ` "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" ` + # representation, that representation will be embedded adding a field + # `value` which holds the custom JSON in addition to the `@type` + # field. Example (for message google.protobuf.Duration): + # ` + # "@type": "type.googleapis.com/google.protobuf.Duration", + # "value": "1.212s" + # ` class Any include Google::Apis::Core::Hashable # A URL/resource name that uniquely identifies the type of the serialized - # protocol buffer message. This string must contain at least one "/" character. - # The last segment of the URL's path must represent the fully qualified name of - # the type (as in `path/google.protobuf.Duration`). The name should be in a - # canonical form (e.g., leading "." is not accepted). + # protocol buffer message. This string must contain at least + # one "/" character. The last segment of the URL's path must represent + # the fully qualified name of the type (as in + # `path/google.protobuf.Duration`). The name should be in a canonical form + # (e.g., leading "." is not accepted). # In practice, teams usually precompile into the binary all types that they - # expect it to use in the context of Any. However, for URLs which use the scheme - # `http`, `https`, or no scheme, one can optionally set up a type server that - # maps type URLs to message definitions as follows: - # * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must - # yield a [google.protobuf.Type][] value in binary format, or produce an error. * - # Applications are allowed to cache lookup results based on the URL, or have - # them precompiled into a binary to avoid any lookup. Therefore, binary - # compatibility needs to be preserved on changes to types. (Use versioned type - # names to manage breaking changes.) - # Note: this functionality is not currently available in the official protobuf - # release, and it is not used for type URLs beginning with type.googleapis.com. - # Schemes other than `http`, `https` (or the empty scheme) might be used with - # implementation specific semantics. + # expect it to use in the context of Any. However, for URLs which use the + # scheme `http`, `https`, or no scheme, one can optionally set up a type + # server that maps type URLs to message definitions as follows: + # * If no scheme is provided, `https` is assumed. + # * An HTTP GET on the URL must yield a google.protobuf.Type + # value in binary format, or produce an error. + # * Applications are allowed to cache lookup results based on the + # URL, or have them precompiled into a binary to avoid any + # lookup. Therefore, binary compatibility needs to be preserved + # on changes to types. (Use versioned type names to manage + # breaking changes.) + # Note: this functionality is not currently available in the official + # protobuf release, and it is not used for type URLs beginning with + # type.googleapis.com. + # Schemes other than `http`, `https` (or the empty scheme) might be + # used with implementation specific semantics. # Corresponds to the JSON property `typeUrl` # @return [String] attr_accessor :type_url @@ -295,70 +361,22 @@ module Google class AppStartTime include Google::Apis::Core::Hashable - # A Duration represents a signed, fixed-length span of time represented as a - # count of seconds and fractions of seconds at nanosecond resolution. It is - # independent of any calendar and concepts like "day" or "month". It is related - # to Timestamp in that the difference between two Timestamp values is a Duration - # and it can be added or subtracted from a Timestamp. Range is approximately +- - # 10,000 years. - # # Examples - # Example 1: Compute Duration from two Timestamps in pseudo code. - # Timestamp start = ...; Timestamp end = ...; Duration duration = ...; - # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - - # start.nanos; - # if (duration.seconds 0) ` duration.seconds += 1; duration.nanos -= 1000000000; - # ` else if (duration.seconds > 0 && duration.nanos < 0) ` duration.seconds -= - # 1; duration.nanos += 1000000000; ` - # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. - # Timestamp start = ...; Duration duration = ...; Timestamp end = ...; - # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + - # duration.nanos; - # if (end.nanos = 1000000000) ` end.seconds += 1; end.nanos -= 1000000000; ` - # Example 3: Compute Duration from datetime.timedelta in Python. - # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration. - # FromTimedelta(td) - # # JSON Mapping - # In JSON format, the Duration type is encoded as a string rather than an object, - # where the string ends in the suffix "s" (indicating seconds) and is preceded - # by the number of seconds, with nanoseconds expressed as fractional seconds. - # For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as " - # 3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3. - # 000000001s", and 3 seconds and 1 microsecond should be expressed in JSON - # format as "3.000001s". + # A Duration represents a signed, fixed-length span of time represented + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". It is related to Timestamp in that the difference between + # two Timestamp values is a Duration and it can be added or subtracted + # from a Timestamp. Range is approximately +-10,000 years. # Corresponds to the JSON property `fullyDrawnTime` # @return [Google::Apis::ToolresultsV1beta3::Duration] attr_accessor :fully_drawn_time - # A Duration represents a signed, fixed-length span of time represented as a - # count of seconds and fractions of seconds at nanosecond resolution. It is - # independent of any calendar and concepts like "day" or "month". It is related - # to Timestamp in that the difference between two Timestamp values is a Duration - # and it can be added or subtracted from a Timestamp. Range is approximately +- - # 10,000 years. - # # Examples - # Example 1: Compute Duration from two Timestamps in pseudo code. - # Timestamp start = ...; Timestamp end = ...; Duration duration = ...; - # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - - # start.nanos; - # if (duration.seconds 0) ` duration.seconds += 1; duration.nanos -= 1000000000; - # ` else if (duration.seconds > 0 && duration.nanos < 0) ` duration.seconds -= - # 1; duration.nanos += 1000000000; ` - # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. - # Timestamp start = ...; Duration duration = ...; Timestamp end = ...; - # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + - # duration.nanos; - # if (end.nanos = 1000000000) ` end.seconds += 1; end.nanos -= 1000000000; ` - # Example 3: Compute Duration from datetime.timedelta in Python. - # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration. - # FromTimedelta(td) - # # JSON Mapping - # In JSON format, the Duration type is encoded as a string rather than an object, - # where the string ends in the suffix "s" (indicating seconds) and is preceded - # by the number of seconds, with nanoseconds expressed as fractional seconds. - # For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as " - # 3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3. - # 000000001s", and 3 seconds and 1 microsecond should be expressed in JSON - # format as "3.000001s". + # A Duration represents a signed, fixed-length span of time represented + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". It is related to Timestamp in that the difference between + # two Timestamp values is a Duration and it can be added or subtracted + # from a Timestamp. Range is approximately +-10,000 years. # Corresponds to the JSON property `initialDisplayTime` # @return [Google::Apis::ToolresultsV1beta3::Duration] attr_accessor :initial_display_time @@ -374,6 +392,19 @@ module Google end end + # A suggestion to use deep links for a Robo run. + class AvailableDeepLinks + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + # Encapsulates the metadata for basic sample series represented by a line chart class BasicPerfSampleSeries include Google::Apis::Core::Hashable @@ -405,8 +436,8 @@ module Google end end - # The request must provide up to a maximum of 5000 samples to be created; a - # larger sample size will cause an INVALID_ARGUMENT error + # The request must provide up to a maximum of 5000 samples to be + # created; a larger sample size will cause an INVALID_ARGUMENT error class BatchCreatePerfSamplesRequest include Google::Apis::Core::Hashable @@ -444,6 +475,26 @@ module Google end end + # A warning that Robo encountered a screen that was mostly blank; this may + # indicate a problem with the app. + class BlankScreen + include Google::Apis::Core::Hashable + + # The screen id of the element + # Corresponds to the JSON property `screenId` + # @return [String] + attr_accessor :screen_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @screen_id = args[:screen_id] if args.key?(:screen_id) + end + end + # class CpuInfo include Google::Apis::Core::Hashable @@ -475,51 +526,47 @@ module Google end end - # A Duration represents a signed, fixed-length span of time represented as a - # count of seconds and fractions of seconds at nanosecond resolution. It is - # independent of any calendar and concepts like "day" or "month". It is related - # to Timestamp in that the difference between two Timestamp values is a Duration - # and it can be added or subtracted from a Timestamp. Range is approximately +- - # 10,000 years. - # # Examples - # Example 1: Compute Duration from two Timestamps in pseudo code. - # Timestamp start = ...; Timestamp end = ...; Duration duration = ...; - # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - - # start.nanos; - # if (duration.seconds 0) ` duration.seconds += 1; duration.nanos -= 1000000000; - # ` else if (duration.seconds > 0 && duration.nanos < 0) ` duration.seconds -= - # 1; duration.nanos += 1000000000; ` - # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. - # Timestamp start = ...; Duration duration = ...; Timestamp end = ...; - # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + - # duration.nanos; - # if (end.nanos = 1000000000) ` end.seconds += 1; end.nanos -= 1000000000; ` - # Example 3: Compute Duration from datetime.timedelta in Python. - # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration. - # FromTimedelta(td) - # # JSON Mapping - # In JSON format, the Duration type is encoded as a string rather than an object, - # where the string ends in the suffix "s" (indicating seconds) and is preceded - # by the number of seconds, with nanoseconds expressed as fractional seconds. - # For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as " - # 3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3. - # 000000001s", and 3 seconds and 1 microsecond should be expressed in JSON - # format as "3.000001s". + # Crash dialog was detected during the test execution + class CrashDialogError + include Google::Apis::Core::Hashable + + # The name of the package that caused the dialog. + # Corresponds to the JSON property `crashPackage` + # @return [String] + attr_accessor :crash_package + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @crash_package = args[:crash_package] if args.key?(:crash_package) + end + end + + # A Duration represents a signed, fixed-length span of time represented + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". It is related to Timestamp in that the difference between + # two Timestamp values is a Duration and it can be added or subtracted + # from a Timestamp. Range is approximately +-10,000 years. class Duration include Google::Apis::Core::Hashable - # Signed fractions of a second at nanosecond resolution of the span of time. - # Durations less than one second are represented with a 0 `seconds` field and a - # positive or negative `nanos` field. For durations of one second or more, a non- - # zero value for the `nanos` field must be of the same sign as the `seconds` - # field. Must be from -999,999,999 to +999,999,999 inclusive. + # Signed fractions of a second at nanosecond resolution of the span + # of time. Durations less than one second are represented with a 0 + # `seconds` field and a positive or negative `nanos` field. For durations + # of one second or more, a non-zero value for the `nanos` field must be + # of the same sign as the `seconds` field. Must be from -999,999,999 + # to +999,999,999 inclusive. # Corresponds to the JSON property `nanos` # @return [Fixnum] attr_accessor :nanos - # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576, - # 000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/ - # hr * 24 hr/day * 365.25 days/year * 10000 years + # Signed seconds of the span of time. Must be from -315,576,000,000 + # to +315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years # Corresponds to the JSON property `seconds` # @return [Fixnum] attr_accessor :seconds @@ -535,138 +582,107 @@ module Google end end + # Additional details about encountered login screens. + class EncounteredLoginScreen + include Google::Apis::Core::Hashable + + # Number of encountered distinct login screens. + # Corresponds to the JSON property `distinctScreens` + # @return [Fixnum] + attr_accessor :distinct_screens + + # Subset of login screens. + # Corresponds to the JSON property `screenIds` + # @return [Array] + attr_accessor :screen_ids + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @distinct_screens = args[:distinct_screens] if args.key?(:distinct_screens) + @screen_ids = args[:screen_ids] if args.key?(:screen_ids) + end + end + + # Additional details about encountered screens with elements that are not + # Android UI widgets. + class EncounteredNonAndroidUiWidgetScreen + include Google::Apis::Core::Hashable + + # Number of encountered distinct screens with non Android UI widgets. + # Corresponds to the JSON property `distinctScreens` + # @return [Fixnum] + attr_accessor :distinct_screens + + # Subset of screens which contain non Android UI widgets. + # Corresponds to the JSON property `screenIds` + # @return [Array] + attr_accessor :screen_ids + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @distinct_screens = args[:distinct_screens] if args.key?(:distinct_screens) + @screen_ids = args[:screen_ids] if args.key?(:screen_ids) + end + end + # An Environment represents the set of test runs (Steps) from the parent - # Execution that are configured with the same set of dimensions (Model, Version, - # Locale, and Orientation). Multiple such runs occur particularly because of - # features like sharding (splitting up a test suite to run in parallel across - # devices) and reruns (running a test multiple times to check for different - # outcomes). + # Execution that are configured with the same set of dimensions (Model, + # Version, Locale, and Orientation). Multiple such runs occur particularly + # because of features like sharding (splitting up a test suite to run in + # parallel across devices) and reruns (running a test multiple times to check + # for different outcomes). class Environment include Google::Apis::Core::Hashable # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at nanosecond - # resolution. The count is relative to an epoch at UTC midnight on January 1, - # 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar - # backwards to year one. + # calendar, encoded as a count of seconds and fractions of seconds at + # nanosecond resolution. The count is relative to an epoch at UTC midnight on + # January 1, 1970, in the proleptic Gregorian calendar which extends the + # Gregorian calendar backwards to year one. # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - # second table is needed for interpretation, using a [24-hour linear smear]( - # https://developers.google.com/time/smear). + # second table is needed for interpretation, using a [24-hour linear + # smear](https://developers.google.com/time/smear). # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - # restricting to that range, we ensure that we can convert to and from [RFC 3339] - # (https://www.ietf.org/rfc/rfc3339.txt) date strings. - # # Examples - # Example 1: Compute Timestamp from POSIX `time()`. - # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); - # Example 2: Compute Timestamp from POSIX `gettimeofday()`. - # struct timeval tv; gettimeofday(&tv, NULL); - # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv. - # tv_usec * 1000); - # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. - # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft. - # dwHighDateTime) << 32) | ft.dwLowDateTime; - # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is - # 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp - # timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); - # timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); - # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. - # long millis = System.currentTimeMillis(); - # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) . - # setNanos((int) ((millis % 1000) * 1000000)).build(); - # Example 5: Compute Timestamp from current time in Python. - # timestamp = Timestamp() timestamp.GetCurrentTime() - # # JSON Mapping - # In JSON format, the Timestamp type is encoded as a string in the [RFC 3339]( - # https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "`year`-` - # month`-`day`T`hour`:`min`:`sec`[.`frac_sec`]Z" where `year` is always - # expressed using four digits while `month`, `day`, `hour`, `min`, and `sec` are - # zero-padded to two digits each. The fractional seconds, which can go up to 9 - # digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix - # indicates the timezone ("UTC"); the timezone is required. A proto3 JSON - # serializer should always use UTC (as indicated by "Z") when printing the - # Timestamp type and a proto3 JSON parser should be able to accept both UTC and - # other timezones (as indicated by an offset). - # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on - # January 15, 2017. - # In JavaScript, one can convert a Date object to this format using the standard - # [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/ - # Reference/Global_Objects/Date/toISOString) method. In Python, a standard ` - # datetime.datetime` object can be converted to this format using [`strftime`]( - # https://docs.python.org/2/library/time.html#time.strftime) with the time - # format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda - # Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/ - # org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D ) to obtain a - # formatter capable of generating timestamps in this format. + # restricting to that range, we ensure that we can convert to and from [RFC + # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Corresponds to the JSON property `completionTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :completion_time # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at nanosecond - # resolution. The count is relative to an epoch at UTC midnight on January 1, - # 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar - # backwards to year one. + # calendar, encoded as a count of seconds and fractions of seconds at + # nanosecond resolution. The count is relative to an epoch at UTC midnight on + # January 1, 1970, in the proleptic Gregorian calendar which extends the + # Gregorian calendar backwards to year one. # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - # second table is needed for interpretation, using a [24-hour linear smear]( - # https://developers.google.com/time/smear). + # second table is needed for interpretation, using a [24-hour linear + # smear](https://developers.google.com/time/smear). # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - # restricting to that range, we ensure that we can convert to and from [RFC 3339] - # (https://www.ietf.org/rfc/rfc3339.txt) date strings. - # # Examples - # Example 1: Compute Timestamp from POSIX `time()`. - # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); - # Example 2: Compute Timestamp from POSIX `gettimeofday()`. - # struct timeval tv; gettimeofday(&tv, NULL); - # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv. - # tv_usec * 1000); - # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. - # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft. - # dwHighDateTime) << 32) | ft.dwLowDateTime; - # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is - # 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp - # timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); - # timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); - # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. - # long millis = System.currentTimeMillis(); - # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) . - # setNanos((int) ((millis % 1000) * 1000000)).build(); - # Example 5: Compute Timestamp from current time in Python. - # timestamp = Timestamp() timestamp.GetCurrentTime() - # # JSON Mapping - # In JSON format, the Timestamp type is encoded as a string in the [RFC 3339]( - # https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "`year`-` - # month`-`day`T`hour`:`min`:`sec`[.`frac_sec`]Z" where `year` is always - # expressed using four digits while `month`, `day`, `hour`, `min`, and `sec` are - # zero-padded to two digits each. The fractional seconds, which can go up to 9 - # digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix - # indicates the timezone ("UTC"); the timezone is required. A proto3 JSON - # serializer should always use UTC (as indicated by "Z") when printing the - # Timestamp type and a proto3 JSON parser should be able to accept both UTC and - # other timezones (as indicated by an offset). - # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on - # January 15, 2017. - # In JavaScript, one can convert a Date object to this format using the standard - # [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/ - # Reference/Global_Objects/Date/toISOString) method. In Python, a standard ` - # datetime.datetime` object can be converted to this format using [`strftime`]( - # https://docs.python.org/2/library/time.html#time.strftime) with the time - # format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda - # Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/ - # org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D ) to obtain a - # formatter capable of generating timestamps in this format. + # restricting to that range, we ensure that we can convert to and from [RFC + # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Corresponds to the JSON property `creationTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :creation_time - # Dimension values describing the environment. Dimension values always consist - # of "Model", "Version", "Locale", and "Orientation". - # - In response: always set - In create request: always set - In update request: - # never set + # Dimension values describing the environment. Dimension values always + # consist of "Model", "Version", "Locale", and "Orientation". + # - In response: always set + # - In create request: always set + # - In update request: never set # Corresponds to the JSON property `dimensionValue` # @return [Array] attr_accessor :dimension_value - # A short human-readable name to display in the UI. Maximum of 100 characters. + # A short human-readable name to display in the UI. + # Maximum of 100 characters. # For example: Nexus 5, API 27. # Corresponds to the JSON property `displayName` # @return [String] @@ -759,131 +775,62 @@ module Google end # An Execution represents a collection of Steps. For instance, it could - # represent: - a mobile test executed across a range of device configurations - - # a jenkins job with a build step followed by a test step + # represent: + # - a mobile test executed across a range of device configurations + # - a jenkins job with a build step followed by a test step # The maximum size of an execution message is 1 MiB. - # An Execution can be updated until its state is set to COMPLETE at which point - # it becomes immutable. + # An Execution can be updated until its state is set to COMPLETE at which + # point it becomes immutable. class Execution include Google::Apis::Core::Hashable # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at nanosecond - # resolution. The count is relative to an epoch at UTC midnight on January 1, - # 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar - # backwards to year one. + # calendar, encoded as a count of seconds and fractions of seconds at + # nanosecond resolution. The count is relative to an epoch at UTC midnight on + # January 1, 1970, in the proleptic Gregorian calendar which extends the + # Gregorian calendar backwards to year one. # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - # second table is needed for interpretation, using a [24-hour linear smear]( - # https://developers.google.com/time/smear). + # second table is needed for interpretation, using a [24-hour linear + # smear](https://developers.google.com/time/smear). # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - # restricting to that range, we ensure that we can convert to and from [RFC 3339] - # (https://www.ietf.org/rfc/rfc3339.txt) date strings. - # # Examples - # Example 1: Compute Timestamp from POSIX `time()`. - # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); - # Example 2: Compute Timestamp from POSIX `gettimeofday()`. - # struct timeval tv; gettimeofday(&tv, NULL); - # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv. - # tv_usec * 1000); - # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. - # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft. - # dwHighDateTime) << 32) | ft.dwLowDateTime; - # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is - # 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp - # timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); - # timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); - # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. - # long millis = System.currentTimeMillis(); - # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) . - # setNanos((int) ((millis % 1000) * 1000000)).build(); - # Example 5: Compute Timestamp from current time in Python. - # timestamp = Timestamp() timestamp.GetCurrentTime() - # # JSON Mapping - # In JSON format, the Timestamp type is encoded as a string in the [RFC 3339]( - # https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "`year`-` - # month`-`day`T`hour`:`min`:`sec`[.`frac_sec`]Z" where `year` is always - # expressed using four digits while `month`, `day`, `hour`, `min`, and `sec` are - # zero-padded to two digits each. The fractional seconds, which can go up to 9 - # digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix - # indicates the timezone ("UTC"); the timezone is required. A proto3 JSON - # serializer should always use UTC (as indicated by "Z") when printing the - # Timestamp type and a proto3 JSON parser should be able to accept both UTC and - # other timezones (as indicated by an offset). - # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on - # January 15, 2017. - # In JavaScript, one can convert a Date object to this format using the standard - # [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/ - # Reference/Global_Objects/Date/toISOString) method. In Python, a standard ` - # datetime.datetime` object can be converted to this format using [`strftime`]( - # https://docs.python.org/2/library/time.html#time.strftime) with the time - # format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda - # Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/ - # org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D ) to obtain a - # formatter capable of generating timestamps in this format. + # restricting to that range, we ensure that we can convert to and from [RFC + # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Corresponds to the JSON property `completionTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :completion_time # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at nanosecond - # resolution. The count is relative to an epoch at UTC midnight on January 1, - # 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar - # backwards to year one. + # calendar, encoded as a count of seconds and fractions of seconds at + # nanosecond resolution. The count is relative to an epoch at UTC midnight on + # January 1, 1970, in the proleptic Gregorian calendar which extends the + # Gregorian calendar backwards to year one. # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - # second table is needed for interpretation, using a [24-hour linear smear]( - # https://developers.google.com/time/smear). + # second table is needed for interpretation, using a [24-hour linear + # smear](https://developers.google.com/time/smear). # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - # restricting to that range, we ensure that we can convert to and from [RFC 3339] - # (https://www.ietf.org/rfc/rfc3339.txt) date strings. - # # Examples - # Example 1: Compute Timestamp from POSIX `time()`. - # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); - # Example 2: Compute Timestamp from POSIX `gettimeofday()`. - # struct timeval tv; gettimeofday(&tv, NULL); - # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv. - # tv_usec * 1000); - # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. - # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft. - # dwHighDateTime) << 32) | ft.dwLowDateTime; - # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is - # 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp - # timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); - # timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); - # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. - # long millis = System.currentTimeMillis(); - # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) . - # setNanos((int) ((millis % 1000) * 1000000)).build(); - # Example 5: Compute Timestamp from current time in Python. - # timestamp = Timestamp() timestamp.GetCurrentTime() - # # JSON Mapping - # In JSON format, the Timestamp type is encoded as a string in the [RFC 3339]( - # https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "`year`-` - # month`-`day`T`hour`:`min`:`sec`[.`frac_sec`]Z" where `year` is always - # expressed using four digits while `month`, `day`, `hour`, `min`, and `sec` are - # zero-padded to two digits each. The fractional seconds, which can go up to 9 - # digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix - # indicates the timezone ("UTC"); the timezone is required. A proto3 JSON - # serializer should always use UTC (as indicated by "Z") when printing the - # Timestamp type and a proto3 JSON parser should be able to accept both UTC and - # other timezones (as indicated by an offset). - # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on - # January 15, 2017. - # In JavaScript, one can convert a Date object to this format using the standard - # [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/ - # Reference/Global_Objects/Date/toISOString) method. In Python, a standard ` - # datetime.datetime` object can be converted to this format using [`strftime`]( - # https://docs.python.org/2/library/time.html#time.strftime) with the time - # format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda - # Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/ - # org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D ) to obtain a - # formatter capable of generating timestamps in this format. + # restricting to that range, we ensure that we can convert to and from [RFC + # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Corresponds to the JSON property `creationTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :creation_time + # The dimensions along which different steps in this execution may vary. + # This must remain fixed over the life of the execution. + # Returns INVALID_ARGUMENT if this field is set in an update request. + # Returns INVALID_ARGUMENT if the same name occurs in more than one + # dimension_definition. + # Returns INVALID_ARGUMENT if the size of the list is over 100. + # - In response: present if set by create + # - In create request: optional + # - In update request: never set + # Corresponds to the JSON property `dimensionDefinitions` + # @return [Array] + attr_accessor :dimension_definitions + # A unique identifier within a History for this Execution. # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - # - In response always set - In create/update request: never set + # - In response always set + # - In create/update request: never set # Corresponds to the JSON property `executionId` # @return [String] attr_accessor :execution_id @@ -900,20 +847,23 @@ module Google # The initial state is IN_PROGRESS. # The only legal state transitions is from IN_PROGRESS to COMPLETE. - # A PRECONDITION_FAILED will be returned if an invalid transition is requested. + # A PRECONDITION_FAILED will be returned if an invalid transition is + # requested. # The state can only be set to COMPLETE once. A FAILED_PRECONDITION will be # returned if the state is set to COMPLETE multiple times. # If the state is set to COMPLETE, all the in-progress steps within the - # execution will be set as COMPLETE. If the outcome of the step is not set, the - # outcome will be set to INCONCLUSIVE. - # - In response always set - In create/update request: optional + # execution will be set as COMPLETE. If the outcome of the step is not set, + # the outcome will be set to INCONCLUSIVE. + # - In response always set + # - In create/update request: optional # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # TestExecution Matrix ID that the TestExecutionService uses. - # - In response: present if set by create - In create: optional - In update: - # never set + # - In response: present if set by create + # - In create: optional + # - In update: never set # Corresponds to the JSON property `testExecutionMatrixId` # @return [String] attr_accessor :test_execution_matrix_id @@ -926,6 +876,7 @@ module Google def update!(**args) @completion_time = args[:completion_time] if args.key?(:completion_time) @creation_time = args[:creation_time] if args.key?(:creation_time) + @dimension_definitions = args[:dimension_definitions] if args.key?(:dimension_definitions) @execution_id = args[:execution_id] if args.key?(:execution_id) @outcome = args[:outcome] if args.key?(:outcome) @specification = args[:specification] if args.key?(:specification) @@ -934,6 +885,19 @@ module Google end end + # Failed to install the APK. + class FailedToInstall + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + # Details for an outcome with a FAILURE outcome summary. class FailureDetail include Google::Apis::Core::Hashable @@ -944,8 +908,8 @@ module Google attr_accessor :crashed alias_method :crashed?, :crashed - # If an app is not installed and thus no test can be run with the app. This - # might be caused by trying to run a test on an unsupported platform. + # If an app is not installed and thus no test can be run with the app. + # This might be caused by trying to run a test on an unsupported platform. # Corresponds to the JSON property `notInstalled` # @return [Boolean] attr_accessor :not_installed @@ -963,7 +927,8 @@ module Google attr_accessor :timed_out alias_method :timed_out?, :timed_out - # If the robo was unable to crawl the app; perhaps because the app did not start. + # If the robo was unable to crawl the app; perhaps because the app did not + # start. # Corresponds to the JSON property `unableToCrawl` # @return [Boolean] attr_accessor :unable_to_crawl @@ -983,16 +948,38 @@ module Google end end + # Additional details for a fatal exception. + class FatalException + include Google::Apis::Core::Hashable + + # A stacktrace. + # Corresponds to the JSON property `stackTrace` + # @return [Google::Apis::ToolresultsV1beta3::StackTrace] + attr_accessor :stack_trace + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @stack_trace = args[:stack_trace] if args.key?(:stack_trace) + end + end + # A reference to a file. class FileReference include Google::Apis::Core::Hashable # The URI of a file stored in Google Cloud Storage. - # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in - # gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs:// - # mybucket/path/to/test.xml#1360383693690000 - # An INVALID_ARGUMENT error will be returned if the URI format is not supported. - # - In response: always set - In create/update request: always set + # For example: http://storage.googleapis.com/mybucket/path/to/test.xml + # or in gsutil format: gs://mybucket/path/to/test.xml + # with version-specific info, + # gs://mybucket/path/to/test.xml#1360383693690000 + # An INVALID_ARGUMENT error will be returned if the URI format is not + # supported. + # - In response: always set + # - In create/update request: always set # Corresponds to the JSON property `fileUri` # @return [String] attr_accessor :file_uri @@ -1007,14 +994,16 @@ module Google end end - # Graphics statistics for the App. The information is collected from 'adb shell - # dumpsys graphicsstats'. For more info see: https://developer.android.com/ - # training/testing/performance.html Statistics will only be present for API 23+. + # Graphics statistics for the App. + # The information is collected from 'adb shell dumpsys graphicsstats'. + # For more info see: + # https://developer.android.com/training/testing/performance.html + # Statistics will only be present for API 23+. class GraphicsStats include Google::Apis::Core::Hashable - # Histogram of frame render times. There should be 154 buckets ranging from [5ms, - # 6ms) to [4950ms, infinity) + # Histogram of frame render times. There should be 154 buckets ranging from + # [5ms, 6ms) to [4950ms, infinity) # Corresponds to the JSON property `buckets` # @return [Array] attr_accessor :buckets @@ -1124,28 +1113,31 @@ module Google # start_timestamp_millis field (descending). It can be used to group all the # Executions of a continuous build. # Note that the ordering only operates on one-dimension. If a repository has - # multiple branches, it means that multiple histories will need to be used in - # order to order Executions per branch. + # multiple branches, it means that multiple histories will need to be + # used in order to order Executions per branch. class History include Google::Apis::Core::Hashable - # A short human-readable (plain text) name to display in the UI. Maximum of 100 - # characters. - # - In response: present if set during create. - In create request: optional + # A short human-readable (plain text) name to display in the UI. + # Maximum of 100 characters. + # - In response: present if set during create. + # - In create request: optional # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # A unique identifier within a project for this History. # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - # - In response always set - In create request: never set + # - In response always set + # - In create request: never set # Corresponds to the JSON property `historyId` # @return [String] attr_accessor :history_id - # A name to uniquely identify a history within a project. Maximum of 200 - # characters. - # - In response always set - In create request: always set + # A name to uniquely identify a history within a project. + # Maximum of 200 characters. + # - In response always set + # - In create request: always set # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1166,12 +1158,12 @@ module Google class Image include Google::Apis::Core::Hashable - # 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). Each `Status` message contains three pieces of - # data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the [ - # API Design Guide](https://cloud.google.com/apis/design/errors). + # 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). Each `Status` message contains + # three pieces of data: error code, error message, and error details. + # You can find out more about this error model and how to work with it in the + # [API Design Guide](https://cloud.google.com/apis/design/errors). # Corresponds to the JSON property `error` # @return [Google::Apis::ToolresultsV1beta3::Status] attr_accessor :error @@ -1205,20 +1197,47 @@ module Google end end + # Additional details of in-app purchases encountered during the crawl. + class InAppPurchasesFound + include Google::Apis::Core::Hashable + + # The total number of in-app purchases flows explored: how many times the + # robo tries to buy a SKU. + # Corresponds to the JSON property `inAppPurchasesFlowsExplored` + # @return [Fixnum] + attr_accessor :in_app_purchases_flows_explored + + # The total number of in-app purchases flows started. + # Corresponds to the JSON property `inAppPurchasesFlowsStarted` + # @return [Fixnum] + attr_accessor :in_app_purchases_flows_started + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @in_app_purchases_flows_explored = args[:in_app_purchases_flows_explored] if args.key?(:in_app_purchases_flows_explored) + @in_app_purchases_flows_started = args[:in_app_purchases_flows_started] if args.key?(:in_app_purchases_flows_started) + end + end + # Details for an outcome with an INCONCLUSIVE outcome summary. class InconclusiveDetail include Google::Apis::Core::Hashable # If the end user aborted the test execution before a pass or fail could be - # determined. For example, the user pressed ctrl-c which sent a kill signal to - # the test runner while the test was running. + # determined. + # For example, the user pressed ctrl-c which sent a kill signal to the test + # runner while the test was running. # Corresponds to the JSON property `abortedByUser` # @return [Boolean] attr_accessor :aborted_by_user alias_method :aborted_by_user?, :aborted_by_user - # If results are being provided to the user in certain cases of infrastructure - # failures + # If results are being provided to the user in certain cases of + # infrastructure failures # Corresponds to the JSON property `hasErrorLogs` # @return [Boolean] attr_accessor :has_error_logs @@ -1245,13 +1264,14 @@ module Google end end - # Step Id and outcome of each individual step that was run as a group with other - # steps with the same configuration. + # Step Id and outcome of each individual step that was run as a group with + # other steps with the same configuration. class IndividualOutcome include Google::Apis::Core::Hashable - # Unique int given to each step. Ranges from 0(inclusive) to total number of - # steps(exclusive). The primary step is 0. + # Unique int given to each step. + # Ranges from 0(inclusive) to total number of steps(exclusive). + # The primary step is 0. # Corresponds to the JSON property `multistepNumber` # @return [Fixnum] attr_accessor :multistep_number @@ -1261,36 +1281,12 @@ module Google # @return [String] attr_accessor :outcome_summary - # A Duration represents a signed, fixed-length span of time represented as a - # count of seconds and fractions of seconds at nanosecond resolution. It is - # independent of any calendar and concepts like "day" or "month". It is related - # to Timestamp in that the difference between two Timestamp values is a Duration - # and it can be added or subtracted from a Timestamp. Range is approximately +- - # 10,000 years. - # # Examples - # Example 1: Compute Duration from two Timestamps in pseudo code. - # Timestamp start = ...; Timestamp end = ...; Duration duration = ...; - # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - - # start.nanos; - # if (duration.seconds 0) ` duration.seconds += 1; duration.nanos -= 1000000000; - # ` else if (duration.seconds > 0 && duration.nanos < 0) ` duration.seconds -= - # 1; duration.nanos += 1000000000; ` - # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. - # Timestamp start = ...; Duration duration = ...; Timestamp end = ...; - # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + - # duration.nanos; - # if (end.nanos = 1000000000) ` end.seconds += 1; end.nanos -= 1000000000; ` - # Example 3: Compute Duration from datetime.timedelta in Python. - # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration. - # FromTimedelta(td) - # # JSON Mapping - # In JSON format, the Duration type is encoded as a string rather than an object, - # where the string ends in the suffix "s" (indicating seconds) and is preceded - # by the number of seconds, with nanoseconds expressed as fractional seconds. - # For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as " - # 3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3. - # 000000001s", and 3 seconds and 1 microsecond should be expressed in JSON - # format as "3.000001s". + # A Duration represents a signed, fixed-length span of time represented + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". It is related to Timestamp in that the difference between + # two Timestamp values is a Duration and it can be added or subtracted + # from a Timestamp. Range is approximately +-10,000 years. # Corresponds to the JSON property `runDuration` # @return [Google::Apis::ToolresultsV1beta3::Duration] attr_accessor :run_duration @@ -1313,6 +1309,51 @@ module Google end end + # A warning that Robo did not crawl potentially important parts of the app. + class InsufficientCoverage + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Additional details for an iOS app crash. + class IosAppCrashed + include Google::Apis::Core::Hashable + + # A stacktrace. + # Corresponds to the JSON property `stackTrace` + # @return [Google::Apis::ToolresultsV1beta3::StackTrace] + attr_accessor :stack_trace + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @stack_trace = args[:stack_trace] if args.key?(:stack_trace) + end + end + + # Failed to find the launcher activity of an app. + class LauncherActivityNotFound + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + # Response message for EnvironmentService.ListEnvironments. class ListEnvironmentsResponse include Google::Apis::Core::Hashable @@ -1399,10 +1440,10 @@ module Google # A continuation token to resume the query at the next item. # Will only be set if there are more histories to fetch. - # Tokens are valid for up to one hour from the time of the first list request. - # For instance, if you make a list request at 1PM and use the token from this - # first request 10 minutes later, the token from this second response will only - # be valid for 50 minutes. + # Tokens are valid for up to one hour from the time of the first list + # request. For instance, if you make a list request at 1PM and use the token + # from this first request 10 minutes later, the token from this second + # response will only be valid for 50 minutes. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1442,8 +1483,8 @@ module Google include Google::Apis::Core::Hashable # Optional, returned if result size exceeds the page size specified in the - # request (or the default page size, 500, if unspecified). It indicates the last - # sample timestamp to be used as page_token in subsequent request + # request (or the default page size, 500, if unspecified). It indicates the + # last sample timestamp to be used as page_token in subsequent request # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1468,7 +1509,8 @@ module Google class ListScreenshotClustersResponse include Google::Apis::Core::Hashable - # The set of clusters associated with an execution Always set + # The set of clusters associated with an execution + # Always set # Corresponds to the JSON property `clusters` # @return [Array] attr_accessor :clusters @@ -1487,17 +1529,19 @@ module Google class ListStepAccessibilityClustersResponse include Google::Apis::Core::Hashable - # A sequence of accessibility suggestions, grouped into clusters. Within the - # sequence, clusters that belong to the same SuggestionCategory should be - # adjacent. Within each category, clusters should be ordered by their - # SuggestionPriority (ERRORs first). The categories should be ordered by their - # highest priority cluster. + # A sequence of accessibility suggestions, grouped into clusters. + # Within the sequence, clusters that belong to the same SuggestionCategory + # should be adjacent. + # Within each category, clusters should be ordered by their + # SuggestionPriority (ERRORs first). + # The categories should be ordered by their highest priority cluster. # Corresponds to the JSON property `clusters` # @return [Array] attr_accessor :clusters - # A full resource name of the step. For example, projects/my-project/histories/ - # bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef + # A full resource name of the step. + # For example, projects/my-project/histories/bh.1234567890abcdef/executions/ + # 1234567890123456789/steps/bs.1234567890abcdef # Always presents. # Corresponds to the JSON property `name` # @return [String] @@ -1527,11 +1571,14 @@ module Google # A list of image data. # Images are returned in a deterministic order; they are ordered by these - # factors, in order of importance: * First, by their associated test case. - # Images without a test case are considered greater than images with one. * - # Second, by their creation time. Images without a creation time are greater - # than images with one. * Third, by the order in which they were added to the - # step (by calls to CreateStep or UpdateStep). + # factors, in order of + # importance: + # * First, by their associated test case. Images without a test case are + # considered greater than images with one. + # * Second, by their creation time. Images without a creation time are + # greater than images with one. + # * Third, by the order in which they were added to the step (by calls to + # CreateStep or UpdateStep). # Corresponds to the JSON property `thumbnails` # @return [Array] attr_accessor :thumbnails @@ -1599,6 +1646,19 @@ module Google end end + # One dimension of the matrix of different runs of a step. + class MatrixDimensionDefinition + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + # class MemoryInfo include Google::Apis::Core::Hashable @@ -1642,16 +1702,17 @@ module Google # @return [String] attr_accessor :state - # The combined and rolled-up result of each test suite that was run as part of - # this environment. - # Combining: When the test cases from a suite are run in different steps ( - # sharding), the results are added back together in one overview. (e.g., if - # shard1 has 2 failures and shard2 has 1 failure than the overview failure_count - # = 3). - # Rollup: When test cases from the same suite are run multiple times (flaky), - # the results are combined (e.g., if testcase1.run1 fails, testcase1.run2 passes, - # and both testcase2.run1 and testcase2.run2 fail then the overview flaky_count - # = 1 and failure_count = 1). + # The combined and rolled-up result of each test suite that was run as part + # of this environment. + # Combining: + # When the test cases from a suite are run in different steps (sharding), + # the results are added back together in one overview. (e.g., if shard1 has + # 2 failures and shard2 has 1 failure than the overview failure_count = 3). + # Rollup: + # When test cases from the same suite are run multiple times (flaky), the + # results are combined (e.g., if testcase1.run1 fails, testcase1.run2 + # passes, and both testcase2.run1 and testcase2.run2 fail then the overview + # flaky_count = 1 and failure_count = 1). # Corresponds to the JSON property `testSuiteOverviews` # @return [Array] attr_accessor :test_suite_overviews @@ -1672,8 +1733,9 @@ module Google class MultiStep include Google::Apis::Core::Hashable - # Unique int given to each step. Ranges from 0(inclusive) to total number of - # steps(exclusive). The primary step is 0. + # Unique int given to each step. + # Ranges from 0(inclusive) to total number of steps(exclusive). + # The primary step is 0. # Corresponds to the JSON property `multistepNumber` # @return [Fixnum] attr_accessor :multistep_number @@ -1701,6 +1763,174 @@ module Google end end + # Additional details for a native crash. + class NativeCrash + include Google::Apis::Core::Hashable + + # A stacktrace. + # Corresponds to the JSON property `stackTrace` + # @return [Google::Apis::ToolresultsV1beta3::StackTrace] + attr_accessor :stack_trace + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @stack_trace = args[:stack_trace] if args.key?(:stack_trace) + end + end + + # A non-sdk API and examples of it being called along with other metadata + # See + # https://developer.android.com/distribute/best-practices/develop/restrictions- + # non-sdk-interfaces + class NonSdkApi + include Google::Apis::Core::Hashable + + # The signature of the Non-SDK API + # Corresponds to the JSON property `apiSignature` + # @return [String] + attr_accessor :api_signature + + # Example stack traces of this API being called. + # Corresponds to the JSON property `exampleStackTraces` + # @return [Array] + attr_accessor :example_stack_traces + + # Optional debugging insights for non-SDK API violations. + # Corresponds to the JSON property `insights` + # @return [Array] + attr_accessor :insights + + # The total number of times this API was observed to have been called. + # Corresponds to the JSON property `invocationCount` + # @return [Fixnum] + attr_accessor :invocation_count + + # Which list this API appears on + # Corresponds to the JSON property `list` + # @return [String] + attr_accessor :list + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @api_signature = args[:api_signature] if args.key?(:api_signature) + @example_stack_traces = args[:example_stack_traces] if args.key?(:example_stack_traces) + @insights = args[:insights] if args.key?(:insights) + @invocation_count = args[:invocation_count] if args.key?(:invocation_count) + @list = args[:list] if args.key?(:list) + end + end + + # Non-SDK API insights (to address debugging solutions). + class NonSdkApiInsight + include Google::Apis::Core::Hashable + + # Optional sample stack traces, for which this insight applies (there + # should be at least one). + # Corresponds to the JSON property `exampleTraceMessages` + # @return [Array] + attr_accessor :example_trace_messages + + # A unique ID, to be used for determining the effectiveness of this + # particular insight in the context of a matcher. (required) + # Corresponds to the JSON property `matcherId` + # @return [String] + attr_accessor :matcher_id + + # This insight indicates that the hidden API usage originates from a + # Google-provided library. Users need not take any action. + # Corresponds to the JSON property `pendingGoogleUpdateInsight` + # @return [Google::Apis::ToolresultsV1beta3::PendingGoogleUpdateInsight] + attr_accessor :pending_google_update_insight + + # This insight is a recommendation to upgrade a given library to the specified + # version, in order to avoid dependencies on non-SDK APIs. + # Corresponds to the JSON property `upgradeInsight` + # @return [Google::Apis::ToolresultsV1beta3::UpgradeInsight] + attr_accessor :upgrade_insight + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @example_trace_messages = args[:example_trace_messages] if args.key?(:example_trace_messages) + @matcher_id = args[:matcher_id] if args.key?(:matcher_id) + @pending_google_update_insight = args[:pending_google_update_insight] if args.key?(:pending_google_update_insight) + @upgrade_insight = args[:upgrade_insight] if args.key?(:upgrade_insight) + end + end + + # Additional details for a non-sdk API usage violation. + class NonSdkApiUsageViolation + include Google::Apis::Core::Hashable + + # Signatures of a subset of those hidden API's. + # Corresponds to the JSON property `apiSignatures` + # @return [Array] + attr_accessor :api_signatures + + # Total number of unique hidden API's accessed. + # Corresponds to the JSON property `uniqueApis` + # @return [Fixnum] + attr_accessor :unique_apis + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @api_signatures = args[:api_signatures] if args.key?(:api_signatures) + @unique_apis = args[:unique_apis] if args.key?(:unique_apis) + end + end + + # Contains a summary and examples of non-sdk API usage violations. + class NonSdkApiUsageViolationReport + include Google::Apis::Core::Hashable + + # Examples of the detected API usages. + # Corresponds to the JSON property `exampleApis` + # @return [Array] + attr_accessor :example_apis + + # Minimum API level required for the application to run. + # Corresponds to the JSON property `minSdkVersion` + # @return [Fixnum] + attr_accessor :min_sdk_version + + # Specifies the API Level on which the application is designed to run. + # Corresponds to the JSON property `targetSdkVersion` + # @return [Fixnum] + attr_accessor :target_sdk_version + + # Total number of unique Non-SDK API's accessed. + # Corresponds to the JSON property `uniqueApis` + # @return [Fixnum] + attr_accessor :unique_apis + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @example_apis = args[:example_apis] if args.key?(:example_apis) + @min_sdk_version = args[:min_sdk_version] if args.key?(:min_sdk_version) + @target_sdk_version = args[:target_sdk_version] if args.key?(:target_sdk_version) + @unique_apis = args[:unique_apis] if args.key?(:unique_apis) + end + end + # Interprets a result so that humans and machines can act on it. class Outcome include Google::Apis::Core::Hashable @@ -1720,7 +1950,8 @@ module Google # @return [Google::Apis::ToolresultsV1beta3::SkippedDetail] attr_accessor :skipped_detail - # Details for an outcome with a SUCCESS outcome summary. LINT.IfChange + # Details for an outcome with a SUCCESS outcome summary. + # LINT.IfChange # Corresponds to the JSON property `successDetail` # @return [Google::Apis::ToolresultsV1beta3::SuccessDetail] attr_accessor :success_detail @@ -1745,6 +1976,52 @@ module Google end end + # A warning that Robo encountered a screen that has overlapping clickable + # elements; this may indicate a potential UI issue. + class OverlappingUiElements + include Google::Apis::Core::Hashable + + # Resource names of the overlapping screen elements + # Corresponds to the JSON property `resourceName` + # @return [Array] + attr_accessor :resource_name + + # The screen id of the elements + # Corresponds to the JSON property `screenId` + # @return [String] + attr_accessor :screen_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @resource_name = args[:resource_name] if args.key?(:resource_name) + @screen_id = args[:screen_id] if args.key?(:screen_id) + end + end + + # This insight indicates that the hidden API usage originates from a + # Google-provided library. Users need not take any action. + class PendingGoogleUpdateInsight + include Google::Apis::Core::Hashable + + # The name of the Google-provided library with the non-SDK API dependency. + # Corresponds to the JSON property `nameOfGoogleLibrary` + # @return [String] + attr_accessor :name_of_google_library + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name_of_google_library = args[:name_of_google_library] if args.key?(:name_of_google_library) + end + end + # Encapsulates performance environment info class PerfEnvironment include Google::Apis::Core::Hashable @@ -1780,18 +2057,22 @@ module Google attr_accessor :app_start_time # A tool results execution ID. + # @OutputOnly # Corresponds to the JSON property `executionId` # @return [String] attr_accessor :execution_id - # Graphics statistics for the App. The information is collected from 'adb shell - # dumpsys graphicsstats'. For more info see: https://developer.android.com/ - # training/testing/performance.html Statistics will only be present for API 23+. + # Graphics statistics for the App. + # The information is collected from 'adb shell dumpsys graphicsstats'. + # For more info see: + # https://developer.android.com/training/testing/performance.html + # Statistics will only be present for API 23+. # Corresponds to the JSON property `graphicsStats` # @return [Google::Apis::ToolresultsV1beta3::GraphicsStats] attr_accessor :graphics_stats # A tool results history ID. + # @OutputOnly # Corresponds to the JSON property `historyId` # @return [String] attr_accessor :history_id @@ -1807,11 +2088,13 @@ module Google attr_accessor :perf_metrics # The cloud project + # @OutputOnly # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # A tool results step ID. + # @OutputOnly # Corresponds to the JSON property `stepId` # @return [String] attr_accessor :step_id @@ -1838,58 +2121,16 @@ module Google include Google::Apis::Core::Hashable # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at nanosecond - # resolution. The count is relative to an epoch at UTC midnight on January 1, - # 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar - # backwards to year one. + # calendar, encoded as a count of seconds and fractions of seconds at + # nanosecond resolution. The count is relative to an epoch at UTC midnight on + # January 1, 1970, in the proleptic Gregorian calendar which extends the + # Gregorian calendar backwards to year one. # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - # second table is needed for interpretation, using a [24-hour linear smear]( - # https://developers.google.com/time/smear). + # second table is needed for interpretation, using a [24-hour linear + # smear](https://developers.google.com/time/smear). # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - # restricting to that range, we ensure that we can convert to and from [RFC 3339] - # (https://www.ietf.org/rfc/rfc3339.txt) date strings. - # # Examples - # Example 1: Compute Timestamp from POSIX `time()`. - # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); - # Example 2: Compute Timestamp from POSIX `gettimeofday()`. - # struct timeval tv; gettimeofday(&tv, NULL); - # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv. - # tv_usec * 1000); - # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. - # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft. - # dwHighDateTime) << 32) | ft.dwLowDateTime; - # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is - # 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp - # timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); - # timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); - # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. - # long millis = System.currentTimeMillis(); - # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) . - # setNanos((int) ((millis % 1000) * 1000000)).build(); - # Example 5: Compute Timestamp from current time in Python. - # timestamp = Timestamp() timestamp.GetCurrentTime() - # # JSON Mapping - # In JSON format, the Timestamp type is encoded as a string in the [RFC 3339]( - # https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "`year`-` - # month`-`day`T`hour`:`min`:`sec`[.`frac_sec`]Z" where `year` is always - # expressed using four digits while `month`, `day`, `hour`, `min`, and `sec` are - # zero-padded to two digits each. The fractional seconds, which can go up to 9 - # digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix - # indicates the timezone ("UTC"); the timezone is required. A proto3 JSON - # serializer should always use UTC (as indicated by "Z") when printing the - # Timestamp type and a proto3 JSON parser should be able to accept both UTC and - # other timezones (as indicated by an offset). - # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on - # January 15, 2017. - # In JavaScript, one can convert a Date object to this format using the standard - # [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/ - # Reference/Global_Objects/Date/toISOString) method. In Python, a standard ` - # datetime.datetime` object can be converted to this format using [`strftime`]( - # https://docs.python.org/2/library/time.html#time.strftime) with the time - # format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda - # Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/ - # org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D ) to obtain a - # formatter capable of generating timestamps in this format. + # restricting to that range, we ensure that we can convert to and from [RFC + # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Corresponds to the JSON property `sampleTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :sample_time @@ -1920,26 +2161,31 @@ module Google attr_accessor :basic_perf_sample_series # A tool results execution ID. + # @OutputOnly # Corresponds to the JSON property `executionId` # @return [String] attr_accessor :execution_id # A tool results history ID. + # @OutputOnly # Corresponds to the JSON property `historyId` # @return [String] attr_accessor :history_id # The cloud project + # @OutputOnly # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # A sample series id + # @OutputOnly # Corresponds to the JSON property `sampleSeriesId` # @return [String] attr_accessor :sample_series_id # A tool results step ID. + # @OutputOnly # Corresponds to the JSON property `stepId` # @return [String] attr_accessor :step_id @@ -1959,6 +2205,38 @@ module Google end end + # A notification that Robo signed in with Google. + class PerformedGoogleLogin + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # A notification that Robo performed some monkey actions. + class PerformedMonkeyActions + include Google::Apis::Core::Hashable + + # The total number of monkey actions performed during the crawl. + # Corresponds to the JSON property `totalActions` + # @return [Fixnum] + attr_accessor :total_actions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @total_actions = args[:total_actions] if args.key?(:total_actions) + end + end + # Stores rollup test status of multiple steps that were run as a group and # outcome of each individual step. class PrimaryStep @@ -1969,8 +2247,8 @@ module Google # @return [Array] attr_accessor :individual_outcome - # Rollup test status of multiple steps that were run with the same configuration - # as a group. + # Rollup test status of multiple steps that were run with the same + # configuration as a group. # Corresponds to the JSON property `rollUp` # @return [String] attr_accessor :roll_up @@ -1992,14 +2270,17 @@ module Google # The name of the Google Cloud Storage bucket to which results are written. # By default, this is unset. - # In update request: optional In response: optional + # In update request: optional + # In response: optional # Corresponds to the JSON property `defaultBucket` # @return [String] attr_accessor :default_bucket # The name of the project's settings. - # Always of the form: projects/`project-id`/settings - # In update request: never set In response: always set + # Always of the form: + # projects/`project-id`/settings + # In update request: never set + # In response: always set # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2040,22 +2321,26 @@ module Google class RegionProto include Google::Apis::Core::Hashable - # The height, in pixels. Always set. + # The height, in pixels. + # Always set. # Corresponds to the JSON property `heightPx` # @return [Fixnum] attr_accessor :height_px - # The left side of the rectangle, in pixels. Always set. + # The left side of the rectangle, in pixels. + # Always set. # Corresponds to the JSON property `leftPx` # @return [Fixnum] attr_accessor :left_px - # The top of the rectangle, in pixels. Always set. + # The top of the rectangle, in pixels. + # Always set. # Corresponds to the JSON property `topPx` # @return [Fixnum] attr_accessor :top_px - # The width, in pixels. Always set. + # The width, in pixels. + # Always set. # Corresponds to the JSON property `widthPx` # @return [Fixnum] attr_accessor :width_px @@ -2098,18 +2383,44 @@ module Google end end - # IMPORTANT: It is unsafe to accept this message from an untrusted source, since - # it's trivial for an attacker to forge serialized messages that don't fulfill - # the type's safety contract -- for example, it could contain attacker - # controlled script. A system which receives a SafeHtmlProto implicitly trusts - # the producer of the SafeHtmlProto. So, it's generally safe to return this - # message in RPC responses, but generally unsafe to accept it in RPC requests. + # Execution stats for a user-provided Robo script. + class RoboScriptExecution + include Google::Apis::Core::Hashable + + # The number of Robo script actions executed successfully. + # Corresponds to the JSON property `successfulActions` + # @return [Fixnum] + attr_accessor :successful_actions + + # The total number of actions in the Robo script. + # Corresponds to the JSON property `totalActions` + # @return [Fixnum] + attr_accessor :total_actions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @successful_actions = args[:successful_actions] if args.key?(:successful_actions) + @total_actions = args[:total_actions] if args.key?(:total_actions) + end + end + + # IMPORTANT: It is unsafe to accept this message from an untrusted source, + # since it's trivial for an attacker to forge serialized messages that + # don't fulfill the type's safety contract -- for example, it could contain + # attacker controlled script. A system which receives a SafeHtmlProto + # implicitly trusts the producer of the SafeHtmlProto. So, it's generally safe + # to return this message in RPC responses, but generally unsafe to accept it + # in RPC requests. class SafeHtmlProto include Google::Apis::Core::Hashable - # IMPORTANT: Never set or read this field, even from tests, it is private. See - # documentation at the top of .proto file for programming language packages with - # which to create or read this message. + # IMPORTANT: Never set or read this field, even from tests, it is private. + # See documentation at the top of .proto file for programming language + # packages with which to create or read this message. # Corresponds to the JSON property `privateDoNotAccessOrElseSafeHtmlWrappedValue` # @return [String] attr_accessor :private_do_not_access_or_else_safe_html_wrapped_value @@ -2128,22 +2439,26 @@ module Google class Screen include Google::Apis::Core::Hashable - # File reference of the png file. Required. + # File reference of the png file. + # Required. # Corresponds to the JSON property `fileReference` # @return [String] attr_accessor :file_reference - # Locale of the device that the screenshot was taken on. Required. + # Locale of the device that the screenshot was taken on. + # Required. # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale - # Model of the device that the screenshot was taken on. Required. + # Model of the device that the screenshot was taken on. + # Required. # Corresponds to the JSON property `model` # @return [String] attr_accessor :model - # OS version of the device that the screenshot was taken on. Required. + # OS version of the device that the screenshot was taken on. + # Required. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -2171,14 +2486,15 @@ module Google attr_accessor :activity # A unique identifier for the cluster. + # @OutputOnly # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id - # A singular screen that represents the cluster as a whole. This screen will act - # as the "cover" of the entire cluster. When users look at the clusters, only - # the key screen from each cluster will be shown. Which screen is the key screen - # is determined by the ClusteringAlgorithm + # A singular screen that represents the cluster as a whole. This screen will + # act as the "cover" of the entire cluster. When users look at the clusters, + # only the key screen from each cluster will be shown. Which screen is the + # key screen is determined by the ClusteringAlgorithm # Corresponds to the JSON property `keyScreen` # @return [Google::Apis::ToolresultsV1beta3::Screen] attr_accessor :key_screen @@ -2205,6 +2521,13 @@ module Google class ShardSummary include Google::Apis::Core::Hashable + # Summaries of the steps belonging to the shard. + # With flaky_test_attempts enabled from TestExecutionService, more than one + # run (Step) can present. And the runs will be sorted by multistep_number. + # Corresponds to the JSON property `runs` + # @return [Array] + attr_accessor :runs + # Merged test result for environment. # If the environment has only one step (no reruns or shards), then the merged # result is the same as the step result. If the environment has multiple shards @@ -2220,6 +2543,7 @@ module Google # Update properties of this object def update!(**args) + @runs = args[:runs] if args.key?(:runs) @shard_result = args[:shard_result] if args.key?(:shard_result) end end @@ -2297,29 +2621,54 @@ module Google end end - # 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). Each `Status` message contains three pieces of - # data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the [ - # API Design Guide](https://cloud.google.com/apis/design/errors). + # User provided intent failed to resolve to an activity. + class StartActivityNotFound + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `action` + # @return [String] + attr_accessor :action + + # + # Corresponds to the JSON property `uri` + # @return [String] + attr_accessor :uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @action = args[:action] if args.key?(:action) + @uri = args[:uri] if args.key?(:uri) + end + end + + # 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). Each `Status` message contains + # three pieces of data: error code, error message, and error details. + # You can find out more about this error model and how to work with it in the + # [API Design Guide](https://cloud.google.com/apis/design/errors). class Status include Google::Apis::Core::Hashable - # The status code, which should be an enum value of [google.rpc.Code][]. + # The status code, which should be an enum value of google.rpc.Code. # Corresponds to the JSON property `code` # @return [Fixnum] attr_accessor :code - # A list of messages that carry the error details. There is a common set of + # A list of messages that carry the error details. There is a common set of # message types for APIs to use. # Corresponds to the JSON property `details` - # @return [Array] + # @return [Array>] attr_accessor :details - # 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. + # 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` # @return [String] attr_accessor :message @@ -2336,221 +2685,121 @@ module Google end end - # A Step represents a single operation performed as part of Execution. A step - # can be used to represent the execution of a tool ( for example a test runner - # execution or an execution of a compiler). - # Steps can overlap (for instance two steps might have the same start time if - # some operations are done in parallel). + # A Step represents a single operation performed as part of + # Execution. A step can be used to represent the execution of a tool ( + # for example a test runner execution or an execution of a compiler). + # Steps can overlap (for instance two steps might have the same + # start time if some operations are done in parallel). # Here is an example, let's consider that we have a continuous build is - # executing a test runner for each iteration. The workflow would look like: - - # user creates a Execution with id 1 - user creates an TestExecutionStep with id - # 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw - # xml log + the service parses the xml logs and returns a TestExecutionStep with - # updated TestResult(s). - user update the status of TestExecutionStep with id - # 100 to COMPLETE - # A Step can be updated until its state is set to COMPLETE at which points it - # becomes immutable. + # executing a test runner for each iteration. The workflow would look like: + # - user creates a Execution with id 1 + # - user creates an TestExecutionStep with id 100 for Execution 1 + # - user update TestExecutionStep with id 100 to add a raw xml log + # + the service parses the xml logs and returns a TestExecutionStep with + # updated TestResult(s). + # - user update the status of TestExecutionStep with id 100 to COMPLETE + # A Step can be updated until its state is set to COMPLETE at which + # points it becomes immutable. # Next tag: 27 class Step include Google::Apis::Core::Hashable # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at nanosecond - # resolution. The count is relative to an epoch at UTC midnight on January 1, - # 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar - # backwards to year one. + # calendar, encoded as a count of seconds and fractions of seconds at + # nanosecond resolution. The count is relative to an epoch at UTC midnight on + # January 1, 1970, in the proleptic Gregorian calendar which extends the + # Gregorian calendar backwards to year one. # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - # second table is needed for interpretation, using a [24-hour linear smear]( - # https://developers.google.com/time/smear). + # second table is needed for interpretation, using a [24-hour linear + # smear](https://developers.google.com/time/smear). # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - # restricting to that range, we ensure that we can convert to and from [RFC 3339] - # (https://www.ietf.org/rfc/rfc3339.txt) date strings. - # # Examples - # Example 1: Compute Timestamp from POSIX `time()`. - # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); - # Example 2: Compute Timestamp from POSIX `gettimeofday()`. - # struct timeval tv; gettimeofday(&tv, NULL); - # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv. - # tv_usec * 1000); - # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. - # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft. - # dwHighDateTime) << 32) | ft.dwLowDateTime; - # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is - # 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp - # timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); - # timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); - # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. - # long millis = System.currentTimeMillis(); - # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) . - # setNanos((int) ((millis % 1000) * 1000000)).build(); - # Example 5: Compute Timestamp from current time in Python. - # timestamp = Timestamp() timestamp.GetCurrentTime() - # # JSON Mapping - # In JSON format, the Timestamp type is encoded as a string in the [RFC 3339]( - # https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "`year`-` - # month`-`day`T`hour`:`min`:`sec`[.`frac_sec`]Z" where `year` is always - # expressed using four digits while `month`, `day`, `hour`, `min`, and `sec` are - # zero-padded to two digits each. The fractional seconds, which can go up to 9 - # digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix - # indicates the timezone ("UTC"); the timezone is required. A proto3 JSON - # serializer should always use UTC (as indicated by "Z") when printing the - # Timestamp type and a proto3 JSON parser should be able to accept both UTC and - # other timezones (as indicated by an offset). - # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on - # January 15, 2017. - # In JavaScript, one can convert a Date object to this format using the standard - # [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/ - # Reference/Global_Objects/Date/toISOString) method. In Python, a standard ` - # datetime.datetime` object can be converted to this format using [`strftime`]( - # https://docs.python.org/2/library/time.html#time.strftime) with the time - # format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda - # Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/ - # org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D ) to obtain a - # formatter capable of generating timestamps in this format. + # restricting to that range, we ensure that we can convert to and from [RFC + # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Corresponds to the JSON property `completionTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :completion_time # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at nanosecond - # resolution. The count is relative to an epoch at UTC midnight on January 1, - # 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar - # backwards to year one. + # calendar, encoded as a count of seconds and fractions of seconds at + # nanosecond resolution. The count is relative to an epoch at UTC midnight on + # January 1, 1970, in the proleptic Gregorian calendar which extends the + # Gregorian calendar backwards to year one. # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - # second table is needed for interpretation, using a [24-hour linear smear]( - # https://developers.google.com/time/smear). + # second table is needed for interpretation, using a [24-hour linear + # smear](https://developers.google.com/time/smear). # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - # restricting to that range, we ensure that we can convert to and from [RFC 3339] - # (https://www.ietf.org/rfc/rfc3339.txt) date strings. - # # Examples - # Example 1: Compute Timestamp from POSIX `time()`. - # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); - # Example 2: Compute Timestamp from POSIX `gettimeofday()`. - # struct timeval tv; gettimeofday(&tv, NULL); - # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv. - # tv_usec * 1000); - # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. - # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft. - # dwHighDateTime) << 32) | ft.dwLowDateTime; - # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is - # 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp - # timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); - # timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); - # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. - # long millis = System.currentTimeMillis(); - # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) . - # setNanos((int) ((millis % 1000) * 1000000)).build(); - # Example 5: Compute Timestamp from current time in Python. - # timestamp = Timestamp() timestamp.GetCurrentTime() - # # JSON Mapping - # In JSON format, the Timestamp type is encoded as a string in the [RFC 3339]( - # https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "`year`-` - # month`-`day`T`hour`:`min`:`sec`[.`frac_sec`]Z" where `year` is always - # expressed using four digits while `month`, `day`, `hour`, `min`, and `sec` are - # zero-padded to two digits each. The fractional seconds, which can go up to 9 - # digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix - # indicates the timezone ("UTC"); the timezone is required. A proto3 JSON - # serializer should always use UTC (as indicated by "Z") when printing the - # Timestamp type and a proto3 JSON parser should be able to accept both UTC and - # other timezones (as indicated by an offset). - # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on - # January 15, 2017. - # In JavaScript, one can convert a Date object to this format using the standard - # [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/ - # Reference/Global_Objects/Date/toISOString) method. In Python, a standard ` - # datetime.datetime` object can be converted to this format using [`strftime`]( - # https://docs.python.org/2/library/time.html#time.strftime) with the time - # format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda - # Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/ - # org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D ) to obtain a - # formatter capable of generating timestamps in this format. + # restricting to that range, we ensure that we can convert to and from [RFC + # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Corresponds to the JSON property `creationTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :creation_time - # A description of this tool For example: mvn clean package -D skipTests=true - # - In response: present if set by create/update request - In create/update - # request: optional + # A description of this tool + # For example: mvn clean package -D skipTests=true + # - In response: present if set by create/update request + # - In create/update request: optional # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # A Duration represents a signed, fixed-length span of time represented as a - # count of seconds and fractions of seconds at nanosecond resolution. It is - # independent of any calendar and concepts like "day" or "month". It is related - # to Timestamp in that the difference between two Timestamp values is a Duration - # and it can be added or subtracted from a Timestamp. Range is approximately +- - # 10,000 years. - # # Examples - # Example 1: Compute Duration from two Timestamps in pseudo code. - # Timestamp start = ...; Timestamp end = ...; Duration duration = ...; - # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - - # start.nanos; - # if (duration.seconds 0) ` duration.seconds += 1; duration.nanos -= 1000000000; - # ` else if (duration.seconds > 0 && duration.nanos < 0) ` duration.seconds -= - # 1; duration.nanos += 1000000000; ` - # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. - # Timestamp start = ...; Duration duration = ...; Timestamp end = ...; - # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + - # duration.nanos; - # if (end.nanos = 1000000000) ` end.seconds += 1; end.nanos -= 1000000000; ` - # Example 3: Compute Duration from datetime.timedelta in Python. - # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration. - # FromTimedelta(td) - # # JSON Mapping - # In JSON format, the Duration type is encoded as a string rather than an object, - # where the string ends in the suffix "s" (indicating seconds) and is preceded - # by the number of seconds, with nanoseconds expressed as fractional seconds. - # For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as " - # 3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3. - # 000000001s", and 3 seconds and 1 microsecond should be expressed in JSON - # format as "3.000001s". + # A Duration represents a signed, fixed-length span of time represented + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". It is related to Timestamp in that the difference between + # two Timestamp values is a Duration and it can be added or subtracted + # from a Timestamp. Range is approximately +-10,000 years. # Corresponds to the JSON property `deviceUsageDuration` # @return [Google::Apis::ToolresultsV1beta3::Duration] attr_accessor :device_usage_duration - # If the execution containing this step has any dimension_definition set, then - # this field allows the child to specify the values of the dimensions. + # If the execution containing this step has any dimension_definition set, + # then this field allows the child to specify the values of the dimensions. # The keys must exactly match the dimension_definition of the execution. - # For example, if the execution has `dimension_definition = ['attempt', 'device'] - # ` then a step must define values for those dimensions, eg. `dimension_value = [ - # 'attempt': '1', 'device': 'Nexus 6']` - # If a step does not participate in one dimension of the matrix, the value for - # that dimension should be empty string. For example, if one of the tests is - # executed by a runner which does not support retries, the step could have ` - # dimension_value = ['attempt': '', 'device': 'Nexus 6']` - # If the step does not participate in any dimensions of the matrix, it may leave - # dimension_value unset. - # A PRECONDITION_FAILED will be returned if any of the keys do not exist in the - # dimension_definition of the execution. + # For example, if the execution has + # `dimension_definition = ['attempt', 'device']` + # then a step must define values for those dimensions, eg. + # `dimension_value = ['attempt': '1', 'device': 'Nexus 6']` + # If a step does not participate in one dimension of the matrix, + # the value for that dimension should be empty string. + # For example, if one of the tests is executed by a runner which + # does not support retries, the step could have + # `dimension_value = ['attempt': '', 'device': 'Nexus 6']` + # If the step does not participate in any dimensions of the matrix, + # it may leave dimension_value unset. + # A PRECONDITION_FAILED will be returned if any of the keys do not exist + # in the dimension_definition of the execution. # A PRECONDITION_FAILED will be returned if another step in this execution # already has the same name and dimension_value, but differs on other data # fields, for example, step field is different. - # A PRECONDITION_FAILED will be returned if dimension_value is set, and there is - # a dimension_definition in the execution which is not specified as one of the - # keys. - # - In response: present if set by create - In create request: optional - In - # update request: never set + # A PRECONDITION_FAILED will be returned if dimension_value is set, and + # there is a dimension_definition in the execution which is not specified + # as one of the keys. + # - In response: present if set by create + # - In create request: optional + # - In update request: never set # Corresponds to the JSON property `dimensionValue` # @return [Array] attr_accessor :dimension_value - # Whether any of the outputs of this step are images whose thumbnails can be - # fetched with ListThumbnails. - # - In response: always set - In create/update request: never set + # Whether any of the outputs of this step are images whose + # thumbnails can be fetched with ListThumbnails. + # - In response: always set + # - In create/update request: never set # Corresponds to the JSON property `hasImages` # @return [Boolean] attr_accessor :has_images alias_method :has_images?, :has_images - # Arbitrary user-supplied key/value pairs that are associated with the step. - # Users are responsible for managing the key namespace such that keys don't - # accidentally collide. - # An INVALID_ARGUMENT will be returned if the number of labels exceeds 100 or if - # the length of any of the keys or values exceeds 100 characters. - # - In response: always set - In create request: optional - In update request: - # optional; any new key/value pair will be added to the map, and any new value - # for an existing key will update that key's value + # Arbitrary user-supplied key/value pairs that are associated with the + # step. + # Users are responsible for managing the key namespace such that keys + # don't accidentally collide. + # An INVALID_ARGUMENT will be returned if the number of labels exceeds 100 or + # if the length of any of the keys or values exceeds 100 characters. + # - In response: always set + # - In create request: optional + # - In update request: optional; any new key/value pair will be added to the + # map, and any new value for an existing key will update that key's value # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels @@ -2560,15 +2809,17 @@ module Google # @return [Google::Apis::ToolresultsV1beta3::MultiStep] attr_accessor :multi_step - # A short human-readable name to display in the UI. Maximum of 100 characters. + # A short human-readable name to display in the UI. + # Maximum of 100 characters. # For example: Clean build - # A PRECONDITION_FAILED will be returned upon creating a new step if it shares - # its name and dimension_value with an existing step. If two steps represent a - # similar action, but have different dimension values, they should share the - # same name. For instance, if the same set of tests is run on two different - # platforms, the two steps should have the same name. - # - In response: always set - In create request: always set - In update request: - # never set + # A PRECONDITION_FAILED will be returned upon creating a new step if it + # shares its name and dimension_value with an existing step. If two steps + # represent a similar action, but have different dimension values, they + # should share the same name. For instance, if the same set of tests is + # run on two different platforms, the two steps should have the same name. + # - In response: always set + # - In create request: always set + # - In update request: never set # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2578,54 +2829,34 @@ module Google # @return [Google::Apis::ToolresultsV1beta3::Outcome] attr_accessor :outcome - # A Duration represents a signed, fixed-length span of time represented as a - # count of seconds and fractions of seconds at nanosecond resolution. It is - # independent of any calendar and concepts like "day" or "month". It is related - # to Timestamp in that the difference between two Timestamp values is a Duration - # and it can be added or subtracted from a Timestamp. Range is approximately +- - # 10,000 years. - # # Examples - # Example 1: Compute Duration from two Timestamps in pseudo code. - # Timestamp start = ...; Timestamp end = ...; Duration duration = ...; - # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - - # start.nanos; - # if (duration.seconds 0) ` duration.seconds += 1; duration.nanos -= 1000000000; - # ` else if (duration.seconds > 0 && duration.nanos < 0) ` duration.seconds -= - # 1; duration.nanos += 1000000000; ` - # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. - # Timestamp start = ...; Duration duration = ...; Timestamp end = ...; - # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + - # duration.nanos; - # if (end.nanos = 1000000000) ` end.seconds += 1; end.nanos -= 1000000000; ` - # Example 3: Compute Duration from datetime.timedelta in Python. - # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration. - # FromTimedelta(td) - # # JSON Mapping - # In JSON format, the Duration type is encoded as a string rather than an object, - # where the string ends in the suffix "s" (indicating seconds) and is preceded - # by the number of seconds, with nanoseconds expressed as fractional seconds. - # For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as " - # 3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3. - # 000000001s", and 3 seconds and 1 microsecond should be expressed in JSON - # format as "3.000001s". + # A Duration represents a signed, fixed-length span of time represented + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". It is related to Timestamp in that the difference between + # two Timestamp values is a Duration and it can be added or subtracted + # from a Timestamp. Range is approximately +-10,000 years. # Corresponds to the JSON property `runDuration` # @return [Google::Apis::ToolresultsV1beta3::Duration] attr_accessor :run_duration - # The initial state is IN_PROGRESS. The only legal state transitions are * - # IN_PROGRESS -> COMPLETE - # A PRECONDITION_FAILED will be returned if an invalid transition is requested. - # It is valid to create Step with a state set to COMPLETE. The state can only be - # set to COMPLETE once. A PRECONDITION_FAILED will be returned if the state is - # set to COMPLETE multiple times. - # - In response: always set - In create/update request: optional + # The initial state is IN_PROGRESS. + # The only legal state transitions are + # * IN_PROGRESS -> COMPLETE + # A PRECONDITION_FAILED will be returned if an invalid transition is + # requested. + # It is valid to create Step with a state set to COMPLETE. + # The state can only be set to COMPLETE once. A PRECONDITION_FAILED will be + # returned if the state is set to COMPLETE multiple times. + # - In response: always set + # - In create/update request: optional # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # A unique identifier within a Execution for this Step. # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - # - In response: always set - In create/update request: never set + # - In response: always set + # - In create/update request: never set # Corresponds to the JSON property `stepId` # @return [String] attr_accessor :step_id @@ -2639,8 +2870,8 @@ module Google # @return [Google::Apis::ToolresultsV1beta3::TestExecutionStep] attr_accessor :test_execution_step - # Generic tool step to be used for binaries we do not explicitly support. For - # example: running cp to copy artifacts from one location to another. + # Generic tool step to be used for binaries we do not explicitly support. + # For example: running cp to copy artifacts from one location to another. # Corresponds to the JSON property `toolExecutionStep` # @return [Google::Apis::ToolresultsV1beta3::ToolExecutionStep] attr_accessor :tool_execution_step @@ -2719,7 +2950,21 @@ module Google end end - # Details for an outcome with a SUCCESS outcome summary. LINT.IfChange + # Lightweight summary of a step within this execution. + class StepSummary + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Details for an outcome with a SUCCESS outcome summary. + # LINT.IfChange class SuccessDetail include Google::Apis::Core::Hashable @@ -2740,19 +2985,20 @@ module Google end # A set of similar suggestions that we suspect are closely related. - # This proto and most of the nested protos are branched from foxandcrown. - # prelaunchreport.service.SuggestionClusterProto, replacing PLR's dependencies - # with FTL's. + # This proto and most of the nested protos are branched from + # foxandcrown.prelaunchreport.service.SuggestionClusterProto, replacing PLR's + # dependencies with FTL's. class SuggestionClusterProto include Google::Apis::Core::Hashable - # Category in which these types of suggestions should appear. Always set. + # Category in which these types of suggestions should appear. + # Always set. # Corresponds to the JSON property `category` # @return [String] attr_accessor :category - # A sequence of suggestions. All of the suggestions within a cluster must have - # the same SuggestionPriority and belong to the same SuggestionCategory. + # A sequence of suggestions. All of the suggestions within a cluster must + # have the same SuggestionPriority and belong to the same SuggestionCategory. # Suggestions with the same screenshot URL should be adjacent. # Corresponds to the JSON property `suggestions` # @return [Array] @@ -2773,30 +3019,32 @@ module Google class SuggestionProto include Google::Apis::Core::Hashable - # Reference to a help center article concerning this type of suggestion. Always - # set. + # Reference to a help center article concerning this type of suggestion. + # Always set. # Corresponds to the JSON property `helpUrl` # @return [String] attr_accessor :help_url - # IMPORTANT: It is unsafe to accept this message from an untrusted source, since - # it's trivial for an attacker to forge serialized messages that don't fulfill - # the type's safety contract -- for example, it could contain attacker - # controlled script. A system which receives a SafeHtmlProto implicitly trusts - # the producer of the SafeHtmlProto. So, it's generally safe to return this - # message in RPC responses, but generally unsafe to accept it in RPC requests. + # IMPORTANT: It is unsafe to accept this message from an untrusted source, + # since it's trivial for an attacker to forge serialized messages that + # don't fulfill the type's safety contract -- for example, it could contain + # attacker controlled script. A system which receives a SafeHtmlProto + # implicitly trusts the producer of the SafeHtmlProto. So, it's generally safe + # to return this message in RPC responses, but generally unsafe to accept it + # in RPC requests. # Corresponds to the JSON property `longMessage` # @return [Google::Apis::ToolresultsV1beta3::SafeHtmlProto] attr_accessor :long_message - # Relative importance of a suggestion. Always set. + # Relative importance of a suggestion. + # Always set. # Corresponds to the JSON property `priority` # @return [String] attr_accessor :priority - # A somewhat human readable identifier of the source view, if it does not have a - # resource_name. This is a path within the accessibility hierarchy, an element - # with resource name; similar to an XPath. + # A somewhat human readable identifier of the source view, if it does not + # have a resource_name. This is a path within the accessibility hierarchy, + # an element with resource name; similar to an XPath. # Corresponds to the JSON property `pseudoResourceId` # @return [String] attr_accessor :pseudo_resource_id @@ -2806,33 +3054,37 @@ module Google # @return [Google::Apis::ToolresultsV1beta3::RegionProto] attr_accessor :region - # Reference to a view element, identified by its resource name, if it has one. + # Reference to a view element, identified by its resource name, if it has + # one. # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name - # ID of the screen for the suggestion. It is used for getting the corresponding - # screenshot path. For example, screen_id "1" corresponds to "1.png" file in GCS. + # ID of the screen for the suggestion. + # It is used for getting the corresponding screenshot path. For example, + # screen_id "1" corresponds to "1.png" file in GCS. # Always set. # Corresponds to the JSON property `screenId` # @return [String] attr_accessor :screen_id - # Relative importance of a suggestion as compared with other suggestions that - # have the same priority and category. This is a meaningless value that can be - # used to order suggestions that are in the same category and have the same - # priority. The larger values have higher priority (i.e., are more important). + # Relative importance of a suggestion as compared with other suggestions + # that have the same priority and category. + # This is a meaningless value that can be used to order suggestions that are + # in the same category and have the same priority. + # The larger values have higher priority (i.e., are more important). # Optional. # Corresponds to the JSON property `secondaryPriority` # @return [Float] attr_accessor :secondary_priority - # IMPORTANT: It is unsafe to accept this message from an untrusted source, since - # it's trivial for an attacker to forge serialized messages that don't fulfill - # the type's safety contract -- for example, it could contain attacker - # controlled script. A system which receives a SafeHtmlProto implicitly trusts - # the producer of the SafeHtmlProto. So, it's generally safe to return this - # message in RPC responses, but generally unsafe to accept it in RPC requests. + # IMPORTANT: It is unsafe to accept this message from an untrusted source, + # since it's trivial for an attacker to forge serialized messages that + # don't fulfill the type's safety contract -- for example, it could contain + # attacker controlled script. A system which receives a SafeHtmlProto + # implicitly trusts the producer of the SafeHtmlProto. So, it's generally safe + # to return this message in RPC responses, but generally unsafe to accept it + # in RPC requests. # Corresponds to the JSON property `shortMessage` # @return [Google::Apis::ToolresultsV1beta3::SafeHtmlProto] attr_accessor :short_message @@ -2866,93 +3118,27 @@ module Google class TestCase include Google::Apis::Core::Hashable - # A Duration represents a signed, fixed-length span of time represented as a - # count of seconds and fractions of seconds at nanosecond resolution. It is - # independent of any calendar and concepts like "day" or "month". It is related - # to Timestamp in that the difference between two Timestamp values is a Duration - # and it can be added or subtracted from a Timestamp. Range is approximately +- - # 10,000 years. - # # Examples - # Example 1: Compute Duration from two Timestamps in pseudo code. - # Timestamp start = ...; Timestamp end = ...; Duration duration = ...; - # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - - # start.nanos; - # if (duration.seconds 0) ` duration.seconds += 1; duration.nanos -= 1000000000; - # ` else if (duration.seconds > 0 && duration.nanos < 0) ` duration.seconds -= - # 1; duration.nanos += 1000000000; ` - # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. - # Timestamp start = ...; Duration duration = ...; Timestamp end = ...; - # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + - # duration.nanos; - # if (end.nanos = 1000000000) ` end.seconds += 1; end.nanos -= 1000000000; ` - # Example 3: Compute Duration from datetime.timedelta in Python. - # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration. - # FromTimedelta(td) - # # JSON Mapping - # In JSON format, the Duration type is encoded as a string rather than an object, - # where the string ends in the suffix "s" (indicating seconds) and is preceded - # by the number of seconds, with nanoseconds expressed as fractional seconds. - # For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as " - # 3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3. - # 000000001s", and 3 seconds and 1 microsecond should be expressed in JSON - # format as "3.000001s". + # A Duration represents a signed, fixed-length span of time represented + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". It is related to Timestamp in that the difference between + # two Timestamp values is a Duration and it can be added or subtracted + # from a Timestamp. Range is approximately +-10,000 years. # Corresponds to the JSON property `elapsedTime` # @return [Google::Apis::ToolresultsV1beta3::Duration] attr_accessor :elapsed_time # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at nanosecond - # resolution. The count is relative to an epoch at UTC midnight on January 1, - # 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar - # backwards to year one. + # calendar, encoded as a count of seconds and fractions of seconds at + # nanosecond resolution. The count is relative to an epoch at UTC midnight on + # January 1, 1970, in the proleptic Gregorian calendar which extends the + # Gregorian calendar backwards to year one. # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - # second table is needed for interpretation, using a [24-hour linear smear]( - # https://developers.google.com/time/smear). + # second table is needed for interpretation, using a [24-hour linear + # smear](https://developers.google.com/time/smear). # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - # restricting to that range, we ensure that we can convert to and from [RFC 3339] - # (https://www.ietf.org/rfc/rfc3339.txt) date strings. - # # Examples - # Example 1: Compute Timestamp from POSIX `time()`. - # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); - # Example 2: Compute Timestamp from POSIX `gettimeofday()`. - # struct timeval tv; gettimeofday(&tv, NULL); - # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv. - # tv_usec * 1000); - # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. - # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft. - # dwHighDateTime) << 32) | ft.dwLowDateTime; - # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is - # 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp - # timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); - # timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); - # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. - # long millis = System.currentTimeMillis(); - # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) . - # setNanos((int) ((millis % 1000) * 1000000)).build(); - # Example 5: Compute Timestamp from current time in Python. - # timestamp = Timestamp() timestamp.GetCurrentTime() - # # JSON Mapping - # In JSON format, the Timestamp type is encoded as a string in the [RFC 3339]( - # https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "`year`-` - # month`-`day`T`hour`:`min`:`sec`[.`frac_sec`]Z" where `year` is always - # expressed using four digits while `month`, `day`, `hour`, `min`, and `sec` are - # zero-padded to two digits each. The fractional seconds, which can go up to 9 - # digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix - # indicates the timezone ("UTC"); the timezone is required. A proto3 JSON - # serializer should always use UTC (as indicated by "Z") when printing the - # Timestamp type and a proto3 JSON parser should be able to accept both UTC and - # other timezones (as indicated by an offset). - # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on - # January 15, 2017. - # In JavaScript, one can convert a Date object to this format using the standard - # [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/ - # Reference/Global_Objects/Date/toISOString) method. In Python, a standard ` - # datetime.datetime` object can be converted to this format using [`strftime`]( - # https://docs.python.org/2/library/time.html#time.strftime) with the time - # format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda - # Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/ - # org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D ) to obtain a - # formatter capable of generating timestamps in this format. + # restricting to that range, we ensure that we can convert to and from [RFC + # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Corresponds to the JSON property `endTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :end_time @@ -2964,66 +3150,24 @@ module Google attr_accessor :skipped_message # The stack trace details if the test case failed or encountered an error. - # The maximum size of the stack traces is 100KiB, beyond which the stack track - # will be truncated. + # The maximum size of the stack traces is 100KiB, beyond which the stack + # track will be truncated. # Zero if the test case passed. # Corresponds to the JSON property `stackTraces` # @return [Array] attr_accessor :stack_traces # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at nanosecond - # resolution. The count is relative to an epoch at UTC midnight on January 1, - # 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar - # backwards to year one. + # calendar, encoded as a count of seconds and fractions of seconds at + # nanosecond resolution. The count is relative to an epoch at UTC midnight on + # January 1, 1970, in the proleptic Gregorian calendar which extends the + # Gregorian calendar backwards to year one. # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - # second table is needed for interpretation, using a [24-hour linear smear]( - # https://developers.google.com/time/smear). + # second table is needed for interpretation, using a [24-hour linear + # smear](https://developers.google.com/time/smear). # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - # restricting to that range, we ensure that we can convert to and from [RFC 3339] - # (https://www.ietf.org/rfc/rfc3339.txt) date strings. - # # Examples - # Example 1: Compute Timestamp from POSIX `time()`. - # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); - # Example 2: Compute Timestamp from POSIX `gettimeofday()`. - # struct timeval tv; gettimeofday(&tv, NULL); - # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv. - # tv_usec * 1000); - # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. - # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft. - # dwHighDateTime) << 32) | ft.dwLowDateTime; - # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is - # 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp - # timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); - # timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); - # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. - # long millis = System.currentTimeMillis(); - # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) . - # setNanos((int) ((millis % 1000) * 1000000)).build(); - # Example 5: Compute Timestamp from current time in Python. - # timestamp = Timestamp() timestamp.GetCurrentTime() - # # JSON Mapping - # In JSON format, the Timestamp type is encoded as a string in the [RFC 3339]( - # https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "`year`-` - # month`-`day`T`hour`:`min`:`sec`[.`frac_sec`]Z" where `year` is always - # expressed using four digits while `month`, `day`, `hour`, `min`, and `sec` are - # zero-padded to two digits each. The fractional seconds, which can go up to 9 - # digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix - # indicates the timezone ("UTC"); the timezone is required. A proto3 JSON - # serializer should always use UTC (as indicated by "Z") when printing the - # Timestamp type and a proto3 JSON parser should be able to accept both UTC and - # other timezones (as indicated by an offset). - # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on - # January 15, 2017. - # In JavaScript, one can convert a Date object to this format using the standard - # [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/ - # Reference/Global_Objects/Date/toISOString) method. In Python, a standard ` - # datetime.datetime` object can be converted to this format using [`strftime`]( - # https://docs.python.org/2/library/time.html#time.strftime) with the time - # format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda - # Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/ - # org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D ) to obtain a - # formatter capable of generating timestamps in this format. + # restricting to that range, we ensure that we can convert to and from [RFC + # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Corresponds to the JSON property `startTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :start_time @@ -3041,13 +3185,16 @@ module Google # A reference to a test case. # Test case references are canonically ordered lexicographically by these three - # factors: * First, by test_suite_name. * Second, by class_name. * Third, by - # name. + # factors: + # * First, by test_suite_name. + # * Second, by class_name. + # * Third, by name. # Corresponds to the JSON property `testCaseReference` # @return [Google::Apis::ToolresultsV1beta3::TestCaseReference] attr_accessor :test_case_reference # References to opaque files of any format output by the tool execution. + # @OutputOnly # Corresponds to the JSON property `toolOutputs` # @return [Array] attr_accessor :tool_outputs @@ -3072,8 +3219,10 @@ module Google # A reference to a test case. # Test case references are canonically ordered lexicographically by these three - # factors: * First, by test_suite_name. * Second, by class_name. * Third, by - # name. + # factors: + # * First, by test_suite_name. + # * Second, by class_name. + # * Third, by name. class TestCaseReference include Google::Apis::Core::Hashable @@ -3114,20 +3263,22 @@ module Google include Google::Apis::Core::Hashable # Issues observed during the test execution. - # For example, if the mobile app under test crashed during the test, the error - # message and the stack trace content can be recorded here to assist debugging. - # - In response: present if set by create or update - In create/update request: - # optional + # For example, if the mobile app under test crashed during the test, + # the error message and the stack trace content can be recorded here + # to assist debugging. + # - In response: present if set by create or update + # - In create/update request: optional # Corresponds to the JSON property `testIssues` # @return [Array] attr_accessor :test_issues - # List of test suite overview contents. This could be parsed from xUnit XML log - # by server, or uploaded directly by user. This references should only be called - # when test suites are fully parsed or uploaded. + # List of test suite overview contents. This could be parsed from xUnit XML + # log by server, or uploaded directly by user. This references should only be + # called when test suites are fully parsed or uploaded. # The maximum allowed number of test suite overviews per step is 1000. - # - In response: always set - In create request: optional - In update request: - # never (use publishXunitXmlFiles custom method instead) + # - In response: always set + # - In create request: optional + # - In update request: never (use publishXunitXmlFiles custom method instead) # Corresponds to the JSON property `testSuiteOverviews` # @return [Array] attr_accessor :test_suite_overviews @@ -3137,8 +3288,8 @@ module Google # @return [Google::Apis::ToolresultsV1beta3::TestTiming] attr_accessor :test_timing - # An execution of an arbitrary tool. It could be a test runner or a tool copying - # artifacts or deploying code. + # An execution of an arbitrary tool. It could be a test runner or a tool + # copying artifacts or deploying code. # Corresponds to the JSON property `toolExecution` # @return [Google::Apis::ToolresultsV1beta3::ToolExecution] attr_accessor :tool_execution @@ -3160,17 +3311,20 @@ module Google class TestIssue include Google::Apis::Core::Hashable - # Category of issue. Required. + # Category of issue. + # Required. # Corresponds to the JSON property `category` # @return [String] attr_accessor :category - # A brief human-readable message describing the issue. Required. + # A brief human-readable message describing the issue. + # Required. # Corresponds to the JSON property `errorMessage` # @return [String] attr_accessor :error_message - # Severity of issue. Required. + # Severity of issue. + # Required. # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity @@ -3180,42 +3334,74 @@ module Google # @return [Google::Apis::ToolresultsV1beta3::StackTrace] attr_accessor :stack_trace - # Type of issue. Required. + # Type of issue. + # Required. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # `Any` contains an arbitrary serialized protocol buffer message along with a # URL that describes the type of the serialized message. - # Protobuf library provides support to pack/unpack Any values in the form of - # utility functions or additional generated methods of the Any type. + # Protobuf library provides support to pack/unpack Any values in the form + # of utility functions or additional generated methods of the Any type. # Example 1: Pack and unpack a message in C++. - # Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) ` ... ` + # Foo foo = ...; + # Any any; + # any.PackFrom(foo); + # ... + # if (any.UnpackTo(&foo)) ` + # ... + # ` # Example 2: Pack and unpack a message in Java. - # Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) ` foo = any. - # unpack(Foo.class); ` + # Foo foo = ...; + # Any any = Any.pack(foo); + # ... + # if (any.is(Foo.class)) ` + # foo = any.unpack(Foo.class); + # ` # Example 3: Pack and unpack a message in Python. - # foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any. - # Unpack(foo) ... + # foo = Foo(...) + # any = Any() + # any.Pack(foo) + # ... + # if any.Is(Foo.DESCRIPTOR): + # any.Unpack(foo) + # ... # Example 4: Pack and unpack a message in Go - # foo := &pb.Foo`...` any, err := ptypes.MarshalAny(foo) ... foo := &pb.Foo`` if - # err := ptypes.UnmarshalAny(any, foo); err != nil ` ... ` - # The pack methods provided by protobuf library will by default use 'type. - # googleapis.com/full.type.name' as the type URL and the unpack methods only use - # the fully qualified type name after the last '/' in the type URL, for example " - # foo.bar.com/x/y.z" will yield type name "y.z". - # JSON ==== The JSON representation of an `Any` value uses the regular - # representation of the deserialized, embedded message, with an additional field - # `@type` which contains the type URL. Example: - # package google.profile; message Person ` string first_name = 1; string - # last_name = 2; ` - # ` "@type": "type.googleapis.com/google.profile.Person", "firstName": , " - # lastName": ` + # foo := &pb.Foo`...` + # any, err := ptypes.MarshalAny(foo) + # ... + # foo := &pb.Foo`` + # if err := ptypes.UnmarshalAny(any, foo); err != nil ` + # ... + # ` + # The pack methods provided by protobuf library will by default use + # 'type.googleapis.com/full.type.name' as the type URL and the unpack + # methods only use the fully qualified type name after the last '/' + # in the type URL, for example "foo.bar.com/x/y.z" will yield type + # name "y.z". + # # JSON + # The JSON representation of an `Any` value uses the regular + # representation of the deserialized, embedded message, with an + # additional field `@type` which contains the type URL. Example: + # package google.profile; + # message Person ` + # string first_name = 1; + # string last_name = 2; + # ` + # ` + # "@type": "type.googleapis.com/google.profile.Person", + # "firstName": , + # "lastName": + # ` # If the embedded message type is well-known and has a custom JSON - # representation, that representation will be embedded adding a field `value` - # which holds the custom JSON in addition to the `@type` field. Example (for - # message [google.protobuf.Duration][]): - # ` "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" ` + # representation, that representation will be embedded adding a field + # `value` which holds the custom JSON in addition to the `@type` + # field. Example (for message google.protobuf.Duration): + # ` + # "@type": "type.googleapis.com/google.protobuf.Duration", + # "value": "1.212s" + # ` # Corresponds to the JSON property `warning` # @return [Google::Apis::ToolresultsV1beta3::Any] attr_accessor :warning @@ -3235,57 +3421,36 @@ module Google end end - # A summary of a test suite result either parsed from XML or uploaded directly - # by a user. - # Note: the API related comments are for StepService only. This message is also - # being used in ExecutionService in a read only mode for the corresponding step. + # A summary of a test suite result either parsed from XML or uploaded + # directly by a user. + # Note: the API related comments are for StepService only. This message is + # also being used in ExecutionService in a read only mode for the corresponding + # step. class TestSuiteOverview include Google::Apis::Core::Hashable - # A Duration represents a signed, fixed-length span of time represented as a - # count of seconds and fractions of seconds at nanosecond resolution. It is - # independent of any calendar and concepts like "day" or "month". It is related - # to Timestamp in that the difference between two Timestamp values is a Duration - # and it can be added or subtracted from a Timestamp. Range is approximately +- - # 10,000 years. - # # Examples - # Example 1: Compute Duration from two Timestamps in pseudo code. - # Timestamp start = ...; Timestamp end = ...; Duration duration = ...; - # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - - # start.nanos; - # if (duration.seconds 0) ` duration.seconds += 1; duration.nanos -= 1000000000; - # ` else if (duration.seconds > 0 && duration.nanos < 0) ` duration.seconds -= - # 1; duration.nanos += 1000000000; ` - # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. - # Timestamp start = ...; Duration duration = ...; Timestamp end = ...; - # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + - # duration.nanos; - # if (end.nanos = 1000000000) ` end.seconds += 1; end.nanos -= 1000000000; ` - # Example 3: Compute Duration from datetime.timedelta in Python. - # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration. - # FromTimedelta(td) - # # JSON Mapping - # In JSON format, the Duration type is encoded as a string rather than an object, - # where the string ends in the suffix "s" (indicating seconds) and is preceded - # by the number of seconds, with nanoseconds expressed as fractional seconds. - # For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as " - # 3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3. - # 000000001s", and 3 seconds and 1 microsecond should be expressed in JSON - # format as "3.000001s". + # A Duration represents a signed, fixed-length span of time represented + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". It is related to Timestamp in that the difference between + # two Timestamp values is a Duration and it can be added or subtracted + # from a Timestamp. Range is approximately +-10,000 years. # Corresponds to the JSON property `elapsedTime` # @return [Google::Apis::ToolresultsV1beta3::Duration] attr_accessor :elapsed_time # Number of test cases in error, typically set by the service by parsing the # xml_source. - # - In create/response: always set - In update request: never + # - In create/response: always set + # - In update request: never # Corresponds to the JSON property `errorCount` # @return [Fixnum] attr_accessor :error_count # Number of failed test cases, typically set by the service by parsing the # xml_source. May also be set by the user. - # - In create/response: always set - In update request: never + # - In create/response: always set + # - In update request: never # Corresponds to the JSON property `failureCount` # @return [Fixnum] attr_accessor :failure_count @@ -3299,20 +3464,24 @@ module Google attr_accessor :flaky_count # The name of the test suite. - # - In create/response: always set - In update request: never + # - In create/response: always set + # - In update request: never # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Number of test cases not run, typically set by the service by parsing the # xml_source. - # - In create/response: always set - In update request: never + # - In create/response: always set + # - In update request: never # Corresponds to the JSON property `skippedCount` # @return [Fixnum] attr_accessor :skipped_count - # Number of test cases, typically set by the service by parsing the xml_source. - # - In create/response: always set - In update request: never + # Number of test cases, typically set by the service by parsing the + # xml_source. + # - In create/response: always set + # - In update request: never # Corresponds to the JSON property `totalCount` # @return [Fixnum] attr_accessor :total_count @@ -3343,36 +3512,12 @@ module Google class TestTiming include Google::Apis::Core::Hashable - # A Duration represents a signed, fixed-length span of time represented as a - # count of seconds and fractions of seconds at nanosecond resolution. It is - # independent of any calendar and concepts like "day" or "month". It is related - # to Timestamp in that the difference between two Timestamp values is a Duration - # and it can be added or subtracted from a Timestamp. Range is approximately +- - # 10,000 years. - # # Examples - # Example 1: Compute Duration from two Timestamps in pseudo code. - # Timestamp start = ...; Timestamp end = ...; Duration duration = ...; - # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - - # start.nanos; - # if (duration.seconds 0) ` duration.seconds += 1; duration.nanos -= 1000000000; - # ` else if (duration.seconds > 0 && duration.nanos < 0) ` duration.seconds -= - # 1; duration.nanos += 1000000000; ` - # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. - # Timestamp start = ...; Duration duration = ...; Timestamp end = ...; - # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + - # duration.nanos; - # if (end.nanos = 1000000000) ` end.seconds += 1; end.nanos -= 1000000000; ` - # Example 3: Compute Duration from datetime.timedelta in Python. - # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration. - # FromTimedelta(td) - # # JSON Mapping - # In JSON format, the Duration type is encoded as a string rather than an object, - # where the string ends in the suffix "s" (indicating seconds) and is preceded - # by the number of seconds, with nanoseconds expressed as fractional seconds. - # For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as " - # 3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3. - # 000000001s", and 3 seconds and 1 microsecond should be expressed in JSON - # format as "3.000001s". + # A Duration represents a signed, fixed-length span of time represented + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". It is related to Timestamp in that the difference between + # two Timestamp values is a Duration and it can be added or subtracted + # from a Timestamp. Range is approximately +-10,000 years. # Corresponds to the JSON property `testProcessDuration` # @return [Google::Apis::ToolresultsV1beta3::Duration] attr_accessor :test_process_duration @@ -3399,7 +3544,8 @@ module Google # The thumbnail file itself. # That is, the bytes here are precisely the bytes that make up the thumbnail - # file; they can be served as an image as-is (with the appropriate content type.) + # file; they can be served as an image as-is (with the appropriate content + # type.) # Always set. # Corresponds to the JSON property `data` # NOTE: Values are automatically base64 encoded/decoded in the client library. @@ -3432,70 +3578,30 @@ module Google end # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at nanosecond - # resolution. The count is relative to an epoch at UTC midnight on January 1, - # 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar - # backwards to year one. + # calendar, encoded as a count of seconds and fractions of seconds at + # nanosecond resolution. The count is relative to an epoch at UTC midnight on + # January 1, 1970, in the proleptic Gregorian calendar which extends the + # Gregorian calendar backwards to year one. # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - # second table is needed for interpretation, using a [24-hour linear smear]( - # https://developers.google.com/time/smear). + # second table is needed for interpretation, using a [24-hour linear + # smear](https://developers.google.com/time/smear). # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - # restricting to that range, we ensure that we can convert to and from [RFC 3339] - # (https://www.ietf.org/rfc/rfc3339.txt) date strings. - # # Examples - # Example 1: Compute Timestamp from POSIX `time()`. - # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); - # Example 2: Compute Timestamp from POSIX `gettimeofday()`. - # struct timeval tv; gettimeofday(&tv, NULL); - # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv. - # tv_usec * 1000); - # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. - # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft. - # dwHighDateTime) << 32) | ft.dwLowDateTime; - # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is - # 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp - # timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); - # timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); - # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. - # long millis = System.currentTimeMillis(); - # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) . - # setNanos((int) ((millis % 1000) * 1000000)).build(); - # Example 5: Compute Timestamp from current time in Python. - # timestamp = Timestamp() timestamp.GetCurrentTime() - # # JSON Mapping - # In JSON format, the Timestamp type is encoded as a string in the [RFC 3339]( - # https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "`year`-` - # month`-`day`T`hour`:`min`:`sec`[.`frac_sec`]Z" where `year` is always - # expressed using four digits while `month`, `day`, `hour`, `min`, and `sec` are - # zero-padded to two digits each. The fractional seconds, which can go up to 9 - # digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix - # indicates the timezone ("UTC"); the timezone is required. A proto3 JSON - # serializer should always use UTC (as indicated by "Z") when printing the - # Timestamp type and a proto3 JSON parser should be able to accept both UTC and - # other timezones (as indicated by an offset). - # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on - # January 15, 2017. - # In JavaScript, one can convert a Date object to this format using the standard - # [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/ - # Reference/Global_Objects/Date/toISOString) method. In Python, a standard ` - # datetime.datetime` object can be converted to this format using [`strftime`]( - # https://docs.python.org/2/library/time.html#time.strftime) with the time - # format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda - # Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/ - # org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D ) to obtain a - # formatter capable of generating timestamps in this format. + # restricting to that range, we ensure that we can convert to and from [RFC + # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. class Timestamp include Google::Apis::Core::Hashable - # Non-negative fractions of a second at nanosecond resolution. Negative second - # values with fractions must still have non-negative nanos values that count - # forward in time. Must be from 0 to 999,999,999 inclusive. + # Non-negative fractions of a second at nanosecond resolution. Negative + # second values with fractions must still have non-negative nanos values + # that count forward in time. Must be from 0 to 999,999,999 + # inclusive. # Corresponds to the JSON property `nanos` # @return [Fixnum] attr_accessor :nanos - # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be - # from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. + # Represents seconds of UTC time since Unix epoch + # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to + # 9999-12-31T23:59:59Z inclusive. # Corresponds to the JSON property `seconds` # @return [Fixnum] attr_accessor :seconds @@ -3511,15 +3617,16 @@ module Google end end - # An execution of an arbitrary tool. It could be a test runner or a tool copying - # artifacts or deploying code. + # An execution of an arbitrary tool. It could be a test runner or a tool + # copying artifacts or deploying code. class ToolExecution include Google::Apis::Core::Hashable - # The full tokenized command line including the program name (equivalent to argv - # in a C program). - # - In response: present if set by create request - In create request: optional - - # In update request: never set + # The full tokenized command line including the program name (equivalent to + # argv in a C program). + # - In response: present if set by create request + # - In create request: optional + # - In update request: never set # Corresponds to the JSON property `commandLineArguments` # @return [Array] attr_accessor :command_line_arguments @@ -3530,21 +3637,23 @@ module Google attr_accessor :exit_code # References to any plain text logs output the tool execution. - # This field can be set before the tool has exited in order to be able to have - # access to a live view of the logs while the tool is running. + # This field can be set before the tool has exited in order to be able to + # have access to a live view of the logs while the tool is running. # The maximum allowed number of tool logs per step is 1000. - # - In response: present if set by create/update request - In create request: - # optional - In update request: optional, any value provided will be appended to - # the existing list + # - In response: present if set by create/update request + # - In create request: optional + # - In update request: optional, any value provided will be appended to the + # existing list # Corresponds to the JSON property `toolLogs` # @return [Array] attr_accessor :tool_logs # References to opaque files of any format output by the tool execution. # The maximum allowed number of tool outputs per step is 1000. - # - In response: present if set by create/update request - In create request: - # optional - In update request: optional, any value provided will be appended to - # the existing list + # - In response: present if set by create/update request + # - In create request: optional + # - In update request: optional, any value provided will be appended to the + # existing list # Corresponds to the JSON property `toolOutputs` # @return [Array] attr_accessor :tool_outputs @@ -3562,13 +3671,13 @@ module Google end end - # Generic tool step to be used for binaries we do not explicitly support. For - # example: running cp to copy artifacts from one location to another. + # Generic tool step to be used for binaries we do not explicitly support. + # For example: running cp to copy artifacts from one location to another. class ToolExecutionStep include Google::Apis::Core::Hashable - # An execution of an arbitrary tool. It could be a test runner or a tool copying - # artifacts or deploying code. + # An execution of an arbitrary tool. It could be a test runner or a tool + # copying artifacts or deploying code. # Corresponds to the JSON property `toolExecution` # @return [Google::Apis::ToolresultsV1beta3::ToolExecution] attr_accessor :tool_execution @@ -3587,8 +3696,10 @@ module Google class ToolExitCode include Google::Apis::Core::Hashable - # Tool execution exit code. A value of 0 means that the execution was successful. - # - In response: always set - In create/update request: always set + # Tool execution exit code. A value of 0 means that the execution was + # successful. + # - In response: always set + # - In create/update request: always set # Corresponds to the JSON property `number` # @return [Fixnum] attr_accessor :number @@ -3608,58 +3719,16 @@ module Google include Google::Apis::Core::Hashable # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at nanosecond - # resolution. The count is relative to an epoch at UTC midnight on January 1, - # 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar - # backwards to year one. + # calendar, encoded as a count of seconds and fractions of seconds at + # nanosecond resolution. The count is relative to an epoch at UTC midnight on + # January 1, 1970, in the proleptic Gregorian calendar which extends the + # Gregorian calendar backwards to year one. # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - # second table is needed for interpretation, using a [24-hour linear smear]( - # https://developers.google.com/time/smear). + # second table is needed for interpretation, using a [24-hour linear + # smear](https://developers.google.com/time/smear). # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - # restricting to that range, we ensure that we can convert to and from [RFC 3339] - # (https://www.ietf.org/rfc/rfc3339.txt) date strings. - # # Examples - # Example 1: Compute Timestamp from POSIX `time()`. - # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); - # Example 2: Compute Timestamp from POSIX `gettimeofday()`. - # struct timeval tv; gettimeofday(&tv, NULL); - # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv. - # tv_usec * 1000); - # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. - # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft. - # dwHighDateTime) << 32) | ft.dwLowDateTime; - # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is - # 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp - # timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); - # timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); - # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. - # long millis = System.currentTimeMillis(); - # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) . - # setNanos((int) ((millis % 1000) * 1000000)).build(); - # Example 5: Compute Timestamp from current time in Python. - # timestamp = Timestamp() timestamp.GetCurrentTime() - # # JSON Mapping - # In JSON format, the Timestamp type is encoded as a string in the [RFC 3339]( - # https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "`year`-` - # month`-`day`T`hour`:`min`:`sec`[.`frac_sec`]Z" where `year` is always - # expressed using four digits while `month`, `day`, `hour`, `min`, and `sec` are - # zero-padded to two digits each. The fractional seconds, which can go up to 9 - # digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix - # indicates the timezone ("UTC"); the timezone is required. A proto3 JSON - # serializer should always use UTC (as indicated by "Z") when printing the - # Timestamp type and a proto3 JSON parser should be able to accept both UTC and - # other timezones (as indicated by an offset). - # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on - # January 15, 2017. - # In JavaScript, one can convert a Date object to this format using the standard - # [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/ - # Reference/Global_Objects/Date/toISOString) method. In Python, a standard ` - # datetime.datetime` object can be converted to this format using [`strftime`]( - # https://docs.python.org/2/library/time.html#time.strftime) with the time - # format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda - # Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/ - # org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D ) to obtain a - # formatter capable of generating timestamps in this format. + # restricting to that range, we ensure that we can convert to and from [RFC + # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Corresponds to the JSON property `creationTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :creation_time @@ -3671,8 +3740,10 @@ module Google # A reference to a test case. # Test case references are canonically ordered lexicographically by these three - # factors: * First, by test_suite_name. * Second, by class_name. * Third, by - # name. + # factors: + # * First, by test_suite_name. + # * Second, by class_name. + # * Third, by name. # Corresponds to the JSON property `testCase` # @return [Google::Apis::ToolresultsV1beta3::TestCaseReference] attr_accessor :test_case @@ -3688,6 +3759,135 @@ module Google @test_case = args[:test_case] if args.key?(:test_case) end end + + # A warning that the screen hierarchy is deeper than the recommended threshold. + class UiElementTooDeep + include Google::Apis::Core::Hashable + + # The depth of the screen element + # Corresponds to the JSON property `depth` + # @return [Fixnum] + attr_accessor :depth + + # The screen id of the element + # Corresponds to the JSON property `screenId` + # @return [String] + attr_accessor :screen_id + + # The screen state id of the element + # Corresponds to the JSON property `screenStateId` + # @return [String] + attr_accessor :screen_state_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @depth = args[:depth] if args.key?(:depth) + @screen_id = args[:screen_id] if args.key?(:screen_id) + @screen_state_id = args[:screen_state_id] if args.key?(:screen_state_id) + end + end + + # Default unspecified warning. + class UnspecifiedWarning + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Additional details of an unused robodirective. + class UnusedRoboDirective + include Google::Apis::Core::Hashable + + # The name of the resource that was unused. + # Corresponds to the JSON property `resourceName` + # @return [String] + attr_accessor :resource_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @resource_name = args[:resource_name] if args.key?(:resource_name) + end + end + + # This insight is a recommendation to upgrade a given library to the specified + # version, in order to avoid dependencies on non-SDK APIs. + class UpgradeInsight + include Google::Apis::Core::Hashable + + # The name of the package to be upgraded. + # Corresponds to the JSON property `packageName` + # @return [String] + attr_accessor :package_name + + # The suggested version to upgrade to. + # Optional: In case we are not sure which version solves this problem + # Corresponds to the JSON property `upgradeToVersion` + # @return [String] + attr_accessor :upgrade_to_version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @package_name = args[:package_name] if args.key?(:package_name) + @upgrade_to_version = args[:upgrade_to_version] if args.key?(:upgrade_to_version) + end + end + + # Additional details of a used Robo directive. + class UsedRoboDirective + include Google::Apis::Core::Hashable + + # The name of the resource that was used. + # Corresponds to the JSON property `resourceName` + # @return [String] + attr_accessor :resource_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @resource_name = args[:resource_name] if args.key?(:resource_name) + end + end + + # Additional details of a used Robo directive with an ignore action. + # Note: This is a different scenario than unused directive. + class UsedRoboIgnoreDirective + include Google::Apis::Core::Hashable + + # The name of the resource that was ignored. + # Corresponds to the JSON property `resourceName` + # @return [String] + attr_accessor :resource_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @resource_name = args[:resource_name] if args.key?(:resource_name) + end + end end end end diff --git a/generated/google/apis/toolresults_v1beta3/representations.rb b/generated/google/apis/toolresults_v1beta3/representations.rb index 155c7f8f6..94a501b42 100644 --- a/generated/google/apis/toolresults_v1beta3/representations.rb +++ b/generated/google/apis/toolresults_v1beta3/representations.rb @@ -22,6 +22,12 @@ module Google module Apis module ToolresultsV1beta3 + class Anr + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class AndroidAppInfo class Representation < Google::Apis::Core::JsonRepresentation; end @@ -46,6 +52,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class AndroidTestLoop + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Any class Representation < Google::Apis::Core::JsonRepresentation; end @@ -58,6 +70,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class AvailableDeepLinks + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class BasicPerfSampleSeries class Representation < Google::Apis::Core::JsonRepresentation; end @@ -76,18 +94,42 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class BlankScreen + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class CpuInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class CrashDialogError + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Duration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class EncounteredLoginScreen + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EncounteredNonAndroidUiWidgetScreen + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Environment class Representation < Google::Apis::Core::JsonRepresentation; end @@ -106,12 +148,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class FailedToInstall + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class FailureDetail class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class FatalException + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class FileReference class Representation < Google::Apis::Core::JsonRepresentation; end @@ -142,6 +196,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class InAppPurchasesFound + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class InconclusiveDetail class Representation < Google::Apis::Core::JsonRepresentation; end @@ -154,6 +214,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class InsufficientCoverage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IosAppCrashed + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LauncherActivityNotFound + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ListEnvironmentsResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -214,6 +292,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class MatrixDimensionDefinition + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class MemoryInfo class Representation < Google::Apis::Core::JsonRepresentation; end @@ -232,12 +316,54 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class NativeCrash + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class NonSdkApi + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class NonSdkApiInsight + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class NonSdkApiUsageViolation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class NonSdkApiUsageViolationReport + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Outcome class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class OverlappingUiElements + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PendingGoogleUpdateInsight + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class PerfEnvironment class Representation < Google::Apis::Core::JsonRepresentation; end @@ -262,6 +388,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class PerformedGoogleLogin + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PerformedMonkeyActions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class PrimaryStep class Representation < Google::Apis::Core::JsonRepresentation; end @@ -292,6 +430,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class RoboScriptExecution + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SafeHtmlProto class Representation < Google::Apis::Core::JsonRepresentation; end @@ -334,6 +478,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class StartActivityNotFound + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Status class Representation < Google::Apis::Core::JsonRepresentation; end @@ -358,6 +508,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class StepSummary + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SuccessDetail class Representation < Google::Apis::Core::JsonRepresentation; end @@ -448,6 +604,50 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class UiElementTooDeep + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UnspecifiedWarning + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UnusedRoboDirective + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UpgradeInsight + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UsedRoboDirective + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UsedRoboIgnoreDirective + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Anr + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :stack_trace, as: 'stackTrace', class: Google::Apis::ToolresultsV1beta3::StackTrace, decorator: Google::Apis::ToolresultsV1beta3::StackTrace::Representation + + end + end + class AndroidAppInfo # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -488,11 +688,19 @@ module Google property :android_robo_test, as: 'androidRoboTest', class: Google::Apis::ToolresultsV1beta3::AndroidRoboTest, decorator: Google::Apis::ToolresultsV1beta3::AndroidRoboTest::Representation + property :android_test_loop, as: 'androidTestLoop', class: Google::Apis::ToolresultsV1beta3::AndroidTestLoop, decorator: Google::Apis::ToolresultsV1beta3::AndroidTestLoop::Representation + property :test_timeout, as: 'testTimeout', class: Google::Apis::ToolresultsV1beta3::Duration, decorator: Google::Apis::ToolresultsV1beta3::Duration::Representation end end + class AndroidTestLoop + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + class Any # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -511,6 +719,12 @@ module Google end end + class AvailableDeepLinks + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + class BasicPerfSampleSeries # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -536,6 +750,13 @@ module Google end end + class BlankScreen + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :screen_id, as: 'screenId' + end + end + class CpuInfo # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -545,6 +766,13 @@ module Google end end + class CrashDialogError + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :crash_package, as: 'crashPackage' + end + end + class Duration # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -553,6 +781,22 @@ module Google end end + class EncounteredLoginScreen + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :distinct_screens, as: 'distinctScreens' + collection :screen_ids, as: 'screenIds' + end + end + + class EncounteredNonAndroidUiWidgetScreen + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :distinct_screens, as: 'distinctScreens' + collection :screen_ids, as: 'screenIds' + end + end + class Environment # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -591,6 +835,8 @@ module Google property :creation_time, as: 'creationTime', class: Google::Apis::ToolresultsV1beta3::Timestamp, decorator: Google::Apis::ToolresultsV1beta3::Timestamp::Representation + collection :dimension_definitions, as: 'dimensionDefinitions', class: Google::Apis::ToolresultsV1beta3::MatrixDimensionDefinition, decorator: Google::Apis::ToolresultsV1beta3::MatrixDimensionDefinition::Representation + property :execution_id, as: 'executionId' property :outcome, as: 'outcome', class: Google::Apis::ToolresultsV1beta3::Outcome, decorator: Google::Apis::ToolresultsV1beta3::Outcome::Representation @@ -601,6 +847,12 @@ module Google end end + class FailedToInstall + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + class FailureDetail # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -612,6 +864,14 @@ module Google end end + class FatalException + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :stack_trace, as: 'stackTrace', class: Google::Apis::ToolresultsV1beta3::StackTrace, decorator: Google::Apis::ToolresultsV1beta3::StackTrace::Representation + + end + end + class FileReference # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -668,6 +928,14 @@ module Google end end + class InAppPurchasesFound + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :in_app_purchases_flows_explored, as: 'inAppPurchasesFlowsExplored' + property :in_app_purchases_flows_started, as: 'inAppPurchasesFlowsStarted' + end + end + class InconclusiveDetail # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -688,6 +956,26 @@ module Google end end + class InsufficientCoverage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class IosAppCrashed + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :stack_trace, as: 'stackTrace', class: Google::Apis::ToolresultsV1beta3::StackTrace, decorator: Google::Apis::ToolresultsV1beta3::StackTrace::Representation + + end + end + + class LauncherActivityNotFound + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + class ListEnvironmentsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -779,6 +1067,12 @@ module Google end end + class MatrixDimensionDefinition + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + class MemoryInfo # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -808,6 +1102,57 @@ module Google end end + class NativeCrash + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :stack_trace, as: 'stackTrace', class: Google::Apis::ToolresultsV1beta3::StackTrace, decorator: Google::Apis::ToolresultsV1beta3::StackTrace::Representation + + end + end + + class NonSdkApi + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :api_signature, as: 'apiSignature' + collection :example_stack_traces, as: 'exampleStackTraces' + collection :insights, as: 'insights', class: Google::Apis::ToolresultsV1beta3::NonSdkApiInsight, decorator: Google::Apis::ToolresultsV1beta3::NonSdkApiInsight::Representation + + property :invocation_count, as: 'invocationCount' + property :list, as: 'list' + end + end + + class NonSdkApiInsight + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :example_trace_messages, as: 'exampleTraceMessages' + property :matcher_id, as: 'matcherId' + property :pending_google_update_insight, as: 'pendingGoogleUpdateInsight', class: Google::Apis::ToolresultsV1beta3::PendingGoogleUpdateInsight, decorator: Google::Apis::ToolresultsV1beta3::PendingGoogleUpdateInsight::Representation + + property :upgrade_insight, as: 'upgradeInsight', class: Google::Apis::ToolresultsV1beta3::UpgradeInsight, decorator: Google::Apis::ToolresultsV1beta3::UpgradeInsight::Representation + + end + end + + class NonSdkApiUsageViolation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :api_signatures, as: 'apiSignatures' + property :unique_apis, as: 'uniqueApis' + end + end + + class NonSdkApiUsageViolationReport + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :example_apis, as: 'exampleApis', class: Google::Apis::ToolresultsV1beta3::NonSdkApi, decorator: Google::Apis::ToolresultsV1beta3::NonSdkApi::Representation + + property :min_sdk_version, as: 'minSdkVersion' + property :target_sdk_version, as: 'targetSdkVersion' + property :unique_apis, as: 'uniqueApis' + end + end + class Outcome # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -823,6 +1168,21 @@ module Google end end + class OverlappingUiElements + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :resource_name, as: 'resourceName' + property :screen_id, as: 'screenId' + end + end + + class PendingGoogleUpdateInsight + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name_of_google_library, as: 'nameOfGoogleLibrary' + end + end + class PerfEnvironment # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -872,6 +1232,19 @@ module Google end end + class PerformedGoogleLogin + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class PerformedMonkeyActions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :total_actions, as: 'totalActions' + end + end + class PrimaryStep # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -917,6 +1290,14 @@ module Google end end + class RoboScriptExecution + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :successful_actions, as: 'successfulActions' + property :total_actions, as: 'totalActions' + end + end + class SafeHtmlProto # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -949,6 +1330,8 @@ module Google class ShardSummary # @private class Representation < Google::Apis::Core::JsonRepresentation + collection :runs, as: 'runs', class: Google::Apis::ToolresultsV1beta3::StepSummary, decorator: Google::Apis::ToolresultsV1beta3::StepSummary::Representation + property :shard_result, as: 'shardResult', class: Google::Apis::ToolresultsV1beta3::MergedResult, decorator: Google::Apis::ToolresultsV1beta3::MergedResult::Representation end @@ -978,12 +1361,19 @@ module Google end end + class StartActivityNotFound + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :action, as: 'action' + property :uri, as: 'uri' + end + end + class Status # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' - collection :details, as: 'details', class: Google::Apis::ToolresultsV1beta3::Any, decorator: Google::Apis::ToolresultsV1beta3::Any::Representation - + collection :details, as: 'details' property :message, as: 'message' end end @@ -1035,6 +1425,12 @@ module Google end end + class StepSummary + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + class SuccessDetail # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1209,6 +1605,50 @@ module Google end end + + class UiElementTooDeep + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :depth, as: 'depth' + property :screen_id, as: 'screenId' + property :screen_state_id, as: 'screenStateId' + end + end + + class UnspecifiedWarning + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class UnusedRoboDirective + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :resource_name, as: 'resourceName' + end + end + + class UpgradeInsight + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :package_name, as: 'packageName' + property :upgrade_to_version, as: 'upgradeToVersion' + end + end + + class UsedRoboDirective + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :resource_name, as: 'resourceName' + end + end + + class UsedRoboIgnoreDirective + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :resource_name, as: 'resourceName' + end + end end end end diff --git a/generated/google/apis/toolresults_v1beta3/service.rb b/generated/google/apis/toolresults_v1beta3/service.rb index 494f21dac..4b7b436d2 100644 --- a/generated/google/apis/toolresults_v1beta3/service.rb +++ b/generated/google/apis/toolresults_v1beta3/service.rb @@ -22,7 +22,7 @@ module Google module ToolresultsV1beta3 # Cloud Tool Results API # - # Reads and publishes results from Firebase Test Lab. + # API to publish and access results from developer tools. # # @example # require 'google/apis/toolresults_v1beta3' @@ -38,453 +38,13 @@ module Google attr_accessor :key # @return [String] - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. attr_accessor :quota_user - # @return [String] - # Deprecated. Please use quotaUser instead. - attr_accessor :user_ip - def initialize - super('https://www.googleapis.com/', 'toolresults/v1beta3/') - @batch_path = 'batch/toolresults/v1beta3' - end - - # Gets the Tool Results settings for a project. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to read from project - # @param [String] project_id - # A Project id. - # Required. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ToolresultsV1beta3::ProjectSettings] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ToolresultsV1beta3::ProjectSettings] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_settings(project_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'projects/{projectId}/settings', options) - command.response_representation = Google::Apis::ToolresultsV1beta3::ProjectSettings::Representation - command.response_class = Google::Apis::ToolresultsV1beta3::ProjectSettings - command.params['projectId'] = project_id unless project_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Creates resources for settings which have not yet been set. - # Currently, this creates a single resource: a Google Cloud Storage bucket, to - # be used as the default bucket for this project. The bucket is created in an - # FTL-own storage project. Except for in rare cases, calling this method in - # parallel from multiple clients will only create a single bucket. In order to - # avoid unnecessary storage charges, the bucket is configured to automatically - # delete objects older than 90 days. - # The bucket is created with the following permissions: - Owner access for - # owners of central storage project (FTL-owned) - Writer access for owners/ - # editors of customer project - Reader access for viewers of customer project - # The default ACL on objects created in the bucket is: - Owner access for owners - # of central storage project - Reader access for owners/editors/viewers of - # customer project See Google Cloud Storage documentation for more details. - # If there is already a default bucket set and the project can access the bucket, - # this call does nothing. However, if the project doesn't have the permission - # to access the bucket or the bucket is deleted, a new bucket will be created. - # May return any canonical error codes, including the following: - # - PERMISSION_DENIED - if the user is not authorized to write to project - Any - # error code raised by Google Cloud Storage - # @param [String] project_id - # A Project id. - # Required. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ToolresultsV1beta3::ProjectSettings] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ToolresultsV1beta3::ProjectSettings] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def initialize_project_settings(project_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'projects/{projectId}:initializeSettings', options) - command.response_representation = Google::Apis::ToolresultsV1beta3::ProjectSettings::Representation - command.response_class = Google::Apis::ToolresultsV1beta3::ProjectSettings - command.params['projectId'] = project_id unless project_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Creates a History. - # The returned History will have the id set. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to write to project - - # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing - # project does not exist - # @param [String] project_id - # A Project id. - # Required. - # @param [Google::Apis::ToolresultsV1beta3::History] history_object - # @param [String] request_id - # A unique request ID for server to detect duplicated requests. For example, a - # UUID. - # Optional, but strongly recommended. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ToolresultsV1beta3::History] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ToolresultsV1beta3::History] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_project_history(project_id, history_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'projects/{projectId}/histories', options) - command.request_representation = Google::Apis::ToolresultsV1beta3::History::Representation - command.request_object = history_object - command.response_representation = Google::Apis::ToolresultsV1beta3::History::Representation - command.response_class = Google::Apis::ToolresultsV1beta3::History - command.params['projectId'] = project_id unless project_id.nil? - command.query['requestId'] = request_id unless request_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Gets a History. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to read project - - # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the History - # does not exist - # @param [String] project_id - # A Project id. - # Required. - # @param [String] history_id - # A History id. - # Required. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ToolresultsV1beta3::History] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ToolresultsV1beta3::History] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_history(project_id, history_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'projects/{projectId}/histories/{historyId}', options) - command.response_representation = Google::Apis::ToolresultsV1beta3::History::Representation - command.response_class = Google::Apis::ToolresultsV1beta3::History - command.params['projectId'] = project_id unless project_id.nil? - command.params['historyId'] = history_id unless history_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Lists Histories for a given Project. - # The histories are sorted by modification time in descending order. The - # history_id key will be used to order the history with the same modification - # time. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to read project - - # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the History - # does not exist - # @param [String] project_id - # A Project id. - # Required. - # @param [String] filter_by_name - # If set, only return histories with the given name. - # Optional. - # @param [Fixnum] page_size - # The maximum number of Histories to fetch. - # Default value: 20. The server will use this default if the field is not set or - # has a value of 0. Any value greater than 100 will be treated as 100. - # Optional. - # @param [String] page_token - # A continuation token to resume the query at the next item. - # Optional. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ToolresultsV1beta3::ListHistoriesResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ToolresultsV1beta3::ListHistoriesResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_histories(project_id, filter_by_name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'projects/{projectId}/histories', options) - command.response_representation = Google::Apis::ToolresultsV1beta3::ListHistoriesResponse::Representation - command.response_class = Google::Apis::ToolresultsV1beta3::ListHistoriesResponse - command.params['projectId'] = project_id unless project_id.nil? - command.query['filterByName'] = filter_by_name unless filter_by_name.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Creates an Execution. - # The returned Execution will have the id set. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to write to project - - # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing - # History does not exist - # @param [String] project_id - # A Project id. - # Required. - # @param [String] history_id - # A History id. - # Required. - # @param [Google::Apis::ToolresultsV1beta3::Execution] execution_object - # @param [String] request_id - # A unique request ID for server to detect duplicated requests. For example, a - # UUID. - # Optional, but strongly recommended. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ToolresultsV1beta3::Execution] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ToolresultsV1beta3::Execution] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_project_history_execution(project_id, history_id, execution_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'projects/{projectId}/histories/{historyId}/executions', options) - command.request_representation = Google::Apis::ToolresultsV1beta3::Execution::Representation - command.request_object = execution_object - command.response_representation = Google::Apis::ToolresultsV1beta3::Execution::Representation - command.response_class = Google::Apis::ToolresultsV1beta3::Execution - command.params['projectId'] = project_id unless project_id.nil? - command.params['historyId'] = history_id unless history_id.nil? - command.query['requestId'] = request_id unless request_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Gets an Execution. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to write to project - - # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Execution - # does not exist - # @param [String] project_id - # A Project id. - # Required. - # @param [String] history_id - # A History id. - # Required. - # @param [String] execution_id - # An Execution id. - # Required. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ToolresultsV1beta3::Execution] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ToolresultsV1beta3::Execution] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_history_execution(project_id, history_id, execution_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'projects/{projectId}/histories/{historyId}/executions/{executionId}', options) - command.response_representation = Google::Apis::ToolresultsV1beta3::Execution::Representation - command.response_class = Google::Apis::ToolresultsV1beta3::Execution - command.params['projectId'] = project_id unless project_id.nil? - command.params['historyId'] = history_id unless history_id.nil? - command.params['executionId'] = execution_id unless execution_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Lists Executions for a given History. - # The executions are sorted by creation_time in descending order. The - # execution_id key will be used to order the executions with the same - # creation_time. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to read project - - # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing - # History does not exist - # @param [String] project_id - # A Project id. - # Required. - # @param [String] history_id - # A History id. - # Required. - # @param [Fixnum] page_size - # The maximum number of Executions to fetch. - # Default value: 25. The server will use this default if the field is not set or - # has a value of 0. - # Optional. - # @param [String] page_token - # A continuation token to resume the query at the next item. - # Optional. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ToolresultsV1beta3::ListExecutionsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ToolresultsV1beta3::ListExecutionsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_history_executions(project_id, history_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'projects/{projectId}/histories/{historyId}/executions', options) - command.response_representation = Google::Apis::ToolresultsV1beta3::ListExecutionsResponse::Representation - command.response_class = Google::Apis::ToolresultsV1beta3::ListExecutionsResponse - command.params['projectId'] = project_id unless project_id.nil? - command.params['historyId'] = history_id unless history_id.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Updates an existing Execution with the supplied partial entity. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to write to project - - # INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the - # requested state transition is illegal - NOT_FOUND - if the containing History - # does not exist - # @param [String] project_id - # A Project id. Required. - # @param [String] history_id - # Required. - # @param [String] execution_id - # Required. - # @param [Google::Apis::ToolresultsV1beta3::Execution] execution_object - # @param [String] request_id - # A unique request ID for server to detect duplicated requests. For example, a - # UUID. - # Optional, but strongly recommended. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ToolresultsV1beta3::Execution] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ToolresultsV1beta3::Execution] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_project_history_execution(project_id, history_id, execution_id, execution_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'projects/{projectId}/histories/{historyId}/executions/{executionId}', options) - command.request_representation = Google::Apis::ToolresultsV1beta3::Execution::Representation - command.request_object = execution_object - command.response_representation = Google::Apis::ToolresultsV1beta3::Execution::Representation - command.response_class = Google::Apis::ToolresultsV1beta3::Execution - command.params['projectId'] = project_id unless project_id.nil? - command.params['historyId'] = history_id unless history_id.nil? - command.params['executionId'] = execution_id unless execution_id.nil? - command.query['requestId'] = request_id unless request_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) + super('https://www.googleapis.com/', '') + @batch_path = 'batch' end # Retrieves a single screenshot cluster by its ID @@ -503,10 +63,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -519,8 +77,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_history_execution_cluster(project_id, history_id, execution_id, cluster_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'projects/{projectId}/histories/{historyId}/executions/{executionId}/clusters/{clusterId}', options) + def get_cluster(project_id, history_id, execution_id, cluster_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/clusters/{clusterId}', options) command.response_representation = Google::Apis::ToolresultsV1beta3::ScreenshotCluster::Representation command.response_class = Google::Apis::ToolresultsV1beta3::ScreenshotCluster command.params['projectId'] = project_id unless project_id.nil? @@ -529,17 +87,17 @@ module Google command.params['clusterId'] = cluster_id unless cluster_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Lists Screenshot Clusters # Returns the list of screenshot clusters corresponding to an execution. - # Screenshot clusters are created after the execution is finished. Clusters are - # created from a set of screenshots. Between any two screenshots, a matching - # score is calculated based off their metadata that determines how similar they - # are. Screenshots are placed in the cluster that has screens which have the - # highest matching scores. + # Screenshot clusters are created after the execution is finished. + # Clusters are created from a set of screenshots. Between any two + # screenshots, a matching score is calculated based off their metadata + # that determines how similar they are. Screenshots are placed + # in the cluster that has screens which have the highest matching + # scores. # @param [String] project_id # A Project id. # Required. @@ -552,10 +110,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -568,8 +124,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_history_execution_clusters(project_id, history_id, execution_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'projects/{projectId}/histories/{historyId}/executions/{executionId}/clusters', options) + def list_clusters(project_id, history_id, execution_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/clusters', options) command.response_representation = Google::Apis::ToolresultsV1beta3::ListScreenshotClustersResponse::Representation command.response_class = Google::Apis::ToolresultsV1beta3::ListScreenshotClustersResponse command.params['projectId'] = project_id unless project_id.nil? @@ -577,15 +133,14 @@ module Google command.params['executionId'] = execution_id unless execution_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets an Environment. # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to read project - - # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the - # Environment does not exist + # - PERMISSION_DENIED - if the user is not authorized to read project + # - INVALID_ARGUMENT - if the request is malformed + # - NOT_FOUND - if the Environment does not exist # @param [String] project_id # Required. A Project id. # @param [String] history_id @@ -597,10 +152,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -613,8 +166,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_history_execution_environment(project_id, history_id, execution_id, environment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'projects/{projectId}/histories/{historyId}/executions/{executionId}/environments/{environmentId}', options) + def get_environment(project_id, history_id, execution_id, environment_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/environments/{environmentId}', options) command.response_representation = Google::Apis::ToolresultsV1beta3::Environment::Representation command.response_class = Google::Apis::ToolresultsV1beta3::Environment command.params['projectId'] = project_id unless project_id.nil? @@ -623,16 +176,15 @@ module Google command.params['environmentId'] = environment_id unless environment_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Lists Environments for a given Execution. # The Environments are sorted by display name. # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to read project - - # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing - # Execution does not exist + # - PERMISSION_DENIED - if the user is not authorized to read project + # - INVALID_ARGUMENT - if the request is malformed + # - NOT_FOUND - if the containing Execution does not exist # @param [String] project_id # Required. A Project id. # @param [String] history_id @@ -641,17 +193,15 @@ module Google # Required. An Execution id. # @param [Fixnum] page_size # The maximum number of Environments to fetch. - # Default value: 25. The server will use this default if the field is not set or - # has a value of 0. + # Default value: 25. The server will use this default if the field is not set + # or has a value of 0. # @param [String] page_token # A continuation token to resume the query at the next item. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -664,8 +214,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_history_execution_environments(project_id, history_id, execution_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'projects/{projectId}/histories/{historyId}/executions/{executionId}/environments', options) + def list_environments(project_id, history_id, execution_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/environments', options) command.response_representation = Google::Apis::ToolresultsV1beta3::ListEnvironmentsResponse::Representation command.response_class = Google::Apis::ToolresultsV1beta3::ListEnvironmentsResponse command.params['projectId'] = project_id unless project_id.nil? @@ -675,115 +225,62 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Lists accessibility clusters for a given Step + # Creates an Execution. + # The returned Execution will have the id set. # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to read project - - # INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if an - # argument in the request happens to be invalid; e.g. if the locale format is - # incorrect - NOT_FOUND - if the containing Step does not exist - # @param [String] name - # A full resource name of the step. For example, projects/my-project/histories/ - # bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef - # Required. - # @param [String] locale - # The accepted format is the canonical Unicode format with hyphen as a delimiter. - # Language must be lowercase, Language Script - Capitalized, Region - UPPERCASE. - # See http://www.unicode.org/reports/tr35/#Unicode_locale_identifier for - # details. - # Required. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ToolresultsV1beta3::ListStepAccessibilityClustersResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ToolresultsV1beta3::ListStepAccessibilityClustersResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def accessibility_project_history_execution_step_clusters(name, locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{+name}:accessibilityClusters', options) - command.response_representation = Google::Apis::ToolresultsV1beta3::ListStepAccessibilityClustersResponse::Representation - command.response_class = Google::Apis::ToolresultsV1beta3::ListStepAccessibilityClustersResponse - command.params['name'] = name unless name.nil? - command.query['locale'] = locale unless locale.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Creates a Step. - # The returned Step will have the id set. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to write to project - - # INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the - # step is too large (more than 10Mib) - NOT_FOUND - if the containing Execution - # does not exist + # - PERMISSION_DENIED - if the user is not authorized to write to project + # - INVALID_ARGUMENT - if the request is malformed + # - NOT_FOUND - if the containing History does not exist # @param [String] project_id - # Required. A Project id. + # A Project id. + # Required. # @param [String] history_id - # Required. A History id. - # @param [String] execution_id - # Required. An Execution id. - # @param [Google::Apis::ToolresultsV1beta3::Step] step_object + # A History id. + # Required. + # @param [Google::Apis::ToolresultsV1beta3::Execution] execution_object # @param [String] request_id - # A unique request ID for server to detect duplicated requests. For example, a - # UUID. + # A unique request ID for server to detect duplicated requests. + # For example, a UUID. # Optional, but strongly recommended. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ToolresultsV1beta3::Step] parsed result object + # @yieldparam result [Google::Apis::ToolresultsV1beta3::Execution] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [Google::Apis::ToolresultsV1beta3::Step] + # @return [Google::Apis::ToolresultsV1beta3::Execution] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_project_history_execution_step(project_id, history_id, execution_id, step_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'projects/{projectId}/histories/{historyId}/executions/{executionId}/steps', options) - command.request_representation = Google::Apis::ToolresultsV1beta3::Step::Representation - command.request_object = step_object - command.response_representation = Google::Apis::ToolresultsV1beta3::Step::Representation - command.response_class = Google::Apis::ToolresultsV1beta3::Step + def create_execution(project_id, history_id, execution_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions', options) + command.request_representation = Google::Apis::ToolresultsV1beta3::Execution::Representation + command.request_object = execution_object + command.response_representation = Google::Apis::ToolresultsV1beta3::Execution::Representation + command.response_class = Google::Apis::ToolresultsV1beta3::Execution command.params['projectId'] = project_id unless project_id.nil? command.params['historyId'] = history_id unless history_id.nil? - command.params['executionId'] = execution_id unless execution_id.nil? command.query['requestId'] = request_id unless request_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Gets a Step. + # Gets an Execution. # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to read project - - # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Step does - # not exist + # - PERMISSION_DENIED - if the user is not authorized to write to project + # - INVALID_ARGUMENT - if the request is malformed + # - NOT_FOUND - if the Execution does not exist # @param [String] project_id # A Project id. # Required. @@ -791,110 +288,55 @@ module Google # A History id. # Required. # @param [String] execution_id - # A Execution id. - # Required. - # @param [String] step_id - # A Step id. + # An Execution id. # Required. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ToolresultsV1beta3::Step] parsed result object + # @yieldparam result [Google::Apis::ToolresultsV1beta3::Execution] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [Google::Apis::ToolresultsV1beta3::Step] + # @return [Google::Apis::ToolresultsV1beta3::Execution] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_history_execution_step(project_id, history_id, execution_id, step_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}', options) - command.response_representation = Google::Apis::ToolresultsV1beta3::Step::Representation - command.response_class = Google::Apis::ToolresultsV1beta3::Step + def get_execution(project_id, history_id, execution_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}', options) + command.response_representation = Google::Apis::ToolresultsV1beta3::Execution::Representation + command.response_class = Google::Apis::ToolresultsV1beta3::Execution command.params['projectId'] = project_id unless project_id.nil? command.params['historyId'] = history_id unless history_id.nil? command.params['executionId'] = execution_id unless execution_id.nil? - command.params['stepId'] = step_id unless step_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Retrieves a PerfMetricsSummary. - # May return any of the following error code(s): - NOT_FOUND - The specified - # PerfMetricsSummary does not exist - # @param [String] project_id - # The cloud project - # @param [String] history_id - # A tool results history ID. - # @param [String] execution_id - # A tool results execution ID. - # @param [String] step_id - # A tool results step ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ToolresultsV1beta3::PerfMetricsSummary] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ToolresultsV1beta3::PerfMetricsSummary] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_history_execution_step_perf_metrics_summary(project_id, history_id, execution_id, step_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfMetricsSummary', options) - command.response_representation = Google::Apis::ToolresultsV1beta3::PerfMetricsSummary::Representation - command.response_class = Google::Apis::ToolresultsV1beta3::PerfMetricsSummary - command.params['projectId'] = project_id unless project_id.nil? - command.params['historyId'] = history_id unless history_id.nil? - command.params['executionId'] = execution_id unless execution_id.nil? - command.params['stepId'] = step_id unless step_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Lists Steps for a given Execution. - # The steps are sorted by creation_time in descending order. The step_id key - # will be used to order the steps with the same creation_time. + # Lists Executions for a given History. + # The executions are sorted by creation_time in descending order. The + # execution_id key will be used to order the executions with the same + # creation_time. # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to read project - - # INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if an - # argument in the request happens to be invalid; e.g. if an attempt is made to - # list the children of a nonexistent Step - NOT_FOUND - if the containing - # Execution does not exist + # - PERMISSION_DENIED - if the user is not authorized to read project + # - INVALID_ARGUMENT - if the request is malformed + # - NOT_FOUND - if the containing History does not exist # @param [String] project_id # A Project id. # Required. # @param [String] history_id # A History id. # Required. - # @param [String] execution_id - # A Execution id. - # Required. # @param [Fixnum] page_size - # The maximum number of Steps to fetch. - # Default value: 25. The server will use this default if the field is not set or - # has a value of 0. + # The maximum number of Executions to fetch. + # Default value: 25. The server will use this default if the field is not set + # or has a value of 0. # Optional. # @param [String] page_token # A continuation token to resume the query at the next item. @@ -902,155 +344,222 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ToolresultsV1beta3::ListStepsResponse] parsed result object + # @yieldparam result [Google::Apis::ToolresultsV1beta3::ListExecutionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [Google::Apis::ToolresultsV1beta3::ListStepsResponse] + # @return [Google::Apis::ToolresultsV1beta3::ListExecutionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_history_execution_steps(project_id, history_id, execution_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'projects/{projectId}/histories/{historyId}/executions/{executionId}/steps', options) - command.response_representation = Google::Apis::ToolresultsV1beta3::ListStepsResponse::Representation - command.response_class = Google::Apis::ToolresultsV1beta3::ListStepsResponse + def list_executions(project_id, history_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions', options) + command.response_representation = Google::Apis::ToolresultsV1beta3::ListExecutionsResponse::Representation + command.response_class = Google::Apis::ToolresultsV1beta3::ListExecutionsResponse command.params['projectId'] = project_id unless project_id.nil? command.params['historyId'] = history_id unless history_id.nil? - command.params['executionId'] = execution_id unless execution_id.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Updates an existing Step with the supplied partial entity. + # Updates an existing Execution with the supplied partial entity. # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to write project - - # INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the - # requested state transition is illegal (e.g try to upload a duplicate xml file), - # if the updated step is too large (more than 10Mib) - NOT_FOUND - if the - # containing Execution does not exist + # - PERMISSION_DENIED - if the user is not authorized to write to project + # - INVALID_ARGUMENT - if the request is malformed + # - FAILED_PRECONDITION - if the requested state transition is illegal + # - NOT_FOUND - if the containing History does not exist # @param [String] project_id # A Project id. # Required. # @param [String] history_id - # A History id. # Required. # @param [String] execution_id - # A Execution id. # Required. - # @param [String] step_id - # A Step id. - # Required. - # @param [Google::Apis::ToolresultsV1beta3::Step] step_object + # @param [Google::Apis::ToolresultsV1beta3::Execution] execution_object # @param [String] request_id - # A unique request ID for server to detect duplicated requests. For example, a - # UUID. + # A unique request ID for server to detect duplicated requests. + # For example, a UUID. # Optional, but strongly recommended. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ToolresultsV1beta3::Step] parsed result object + # @yieldparam result [Google::Apis::ToolresultsV1beta3::Execution] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [Google::Apis::ToolresultsV1beta3::Step] + # @return [Google::Apis::ToolresultsV1beta3::Execution] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_project_history_execution_step(project_id, history_id, execution_id, step_id, step_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}', options) - command.request_representation = Google::Apis::ToolresultsV1beta3::Step::Representation - command.request_object = step_object - command.response_representation = Google::Apis::ToolresultsV1beta3::Step::Representation - command.response_class = Google::Apis::ToolresultsV1beta3::Step + def patch_execution(project_id, history_id, execution_id, execution_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}', options) + command.request_representation = Google::Apis::ToolresultsV1beta3::Execution::Representation + command.request_object = execution_object + command.response_representation = Google::Apis::ToolresultsV1beta3::Execution::Representation + command.response_class = Google::Apis::ToolresultsV1beta3::Execution command.params['projectId'] = project_id unless project_id.nil? command.params['historyId'] = history_id unless history_id.nil? command.params['executionId'] = execution_id unless execution_id.nil? - command.params['stepId'] = step_id unless step_id.nil? command.query['requestId'] = request_id unless request_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Publish xml files to an existing Step. + # Creates a History. + # The returned History will have the id set. # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to write project - - # INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the - # requested state transition is illegal, e.g try to upload a duplicate xml file - # or a file too large. - NOT_FOUND - if the containing Execution does not exist + # - PERMISSION_DENIED - if the user is not authorized to write to project + # - INVALID_ARGUMENT - if the request is malformed + # - NOT_FOUND - if the containing project does not exist + # @param [String] project_id + # A Project id. + # Required. + # @param [Google::Apis::ToolresultsV1beta3::History] history_object + # @param [String] request_id + # A unique request ID for server to detect duplicated requests. + # For example, a UUID. + # Optional, but strongly recommended. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ToolresultsV1beta3::History] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ToolresultsV1beta3::History] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_history(project_id, history_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'toolresults/v1beta3/projects/{projectId}/histories', options) + command.request_representation = Google::Apis::ToolresultsV1beta3::History::Representation + command.request_object = history_object + command.response_representation = Google::Apis::ToolresultsV1beta3::History::Representation + command.response_class = Google::Apis::ToolresultsV1beta3::History + command.params['projectId'] = project_id unless project_id.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a History. + # May return any of the following canonical error codes: + # - PERMISSION_DENIED - if the user is not authorized to read project + # - INVALID_ARGUMENT - if the request is malformed + # - NOT_FOUND - if the History does not exist # @param [String] project_id # A Project id. # Required. # @param [String] history_id # A History id. # Required. - # @param [String] execution_id - # A Execution id. - # Required. - # @param [String] step_id - # A Step id. Note: This step must include a TestExecutionStep. - # Required. - # @param [Google::Apis::ToolresultsV1beta3::PublishXunitXmlFilesRequest] publish_xunit_xml_files_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ToolresultsV1beta3::Step] parsed result object + # @yieldparam result [Google::Apis::ToolresultsV1beta3::History] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [Google::Apis::ToolresultsV1beta3::Step] + # @return [Google::Apis::ToolresultsV1beta3::History] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def publish_step_xunit_xml_files(project_id, history_id, execution_id, step_id, publish_xunit_xml_files_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}:publishXunitXmlFiles', options) - command.request_representation = Google::Apis::ToolresultsV1beta3::PublishXunitXmlFilesRequest::Representation - command.request_object = publish_xunit_xml_files_request_object - command.response_representation = Google::Apis::ToolresultsV1beta3::Step::Representation - command.response_class = Google::Apis::ToolresultsV1beta3::Step + def get_history(project_id, history_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}', options) + command.response_representation = Google::Apis::ToolresultsV1beta3::History::Representation + command.response_class = Google::Apis::ToolresultsV1beta3::History command.params['projectId'] = project_id unless project_id.nil? command.params['historyId'] = history_id unless history_id.nil? - command.params['executionId'] = execution_id unless execution_id.nil? - command.params['stepId'] = step_id unless step_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Lists Histories for a given Project. + # The histories are sorted by modification time in descending order. The + # history_id key will be used to order the history with the same + # modification time. + # May return any of the following canonical error codes: + # - PERMISSION_DENIED - if the user is not authorized to read project + # - INVALID_ARGUMENT - if the request is malformed + # - NOT_FOUND - if the History does not exist + # @param [String] project_id + # A Project id. + # Required. + # @param [String] filter_by_name + # If set, only return histories with the given name. + # Optional. + # @param [Fixnum] page_size + # The maximum number of Histories to fetch. + # Default value: 20. The server will use this default if the field is not set + # or has a value of 0. Any value greater than 100 will be treated as 100. + # Optional. + # @param [String] page_token + # A continuation token to resume the query at the next item. + # Optional. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ToolresultsV1beta3::ListHistoriesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ToolresultsV1beta3::ListHistoriesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_histories(project_id, filter_by_name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories', options) + command.response_representation = Google::Apis::ToolresultsV1beta3::ListHistoriesResponse::Representation + command.response_class = Google::Apis::ToolresultsV1beta3::ListHistoriesResponse + command.params['projectId'] = project_id unless project_id.nil? + command.query['filterByName'] = filter_by_name unless filter_by_name.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Creates a PerfMetricsSummary resource. Returns the existing one if it has # already been created. - # May return any of the following error code(s): - NOT_FOUND - The containing - # Step does not exist + # May return any of the following error code(s): + # - NOT_FOUND - The containing Step does not exist # @param [String] project_id # The cloud project # @param [String] history_id @@ -1063,10 +572,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1079,8 +586,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_project_history_execution_step_perf_metrics_summary(project_id, history_id, execution_id, step_id, perf_metrics_summary_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfMetricsSummary', options) + def create_perf_metrics_summary(project_id, history_id, execution_id, step_id, perf_metrics_summary_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfMetricsSummary', options) command.request_representation = Google::Apis::ToolresultsV1beta3::PerfMetricsSummary::Representation command.request_object = perf_metrics_summary_object command.response_representation = Google::Apis::ToolresultsV1beta3::PerfMetricsSummary::Representation @@ -1091,14 +598,13 @@ module Google command.params['stepId'] = step_id unless step_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Creates a PerfSampleSeries. - # May return any of the following error code(s): - ALREADY_EXISTS - - # PerfMetricSummary already exists for the given Step - NOT_FOUND - The - # containing Step does not exist + # May return any of the following error code(s): + # - ALREADY_EXISTS - PerfMetricSummary already exists for the given Step + # - NOT_FOUND - The containing Step does not exist # @param [String] project_id # The cloud project # @param [String] history_id @@ -1111,10 +617,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1127,8 +631,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_project_history_execution_step_perf_sample_series(project_id, history_id, execution_id, step_id, perf_sample_series_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries', options) + def create_perf_sample_series(project_id, history_id, execution_id, step_id, perf_sample_series_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries', options) command.request_representation = Google::Apis::ToolresultsV1beta3::PerfSampleSeries::Representation command.request_object = perf_sample_series_object command.response_representation = Google::Apis::ToolresultsV1beta3::PerfSampleSeries::Representation @@ -1139,13 +643,12 @@ module Google command.params['stepId'] = step_id unless step_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets a PerfSampleSeries. - # May return any of the following error code(s): - NOT_FOUND - The specified - # PerfSampleSeries does not exist + # May return any of the following error code(s): + # - NOT_FOUND - The specified PerfSampleSeries does not exist # @param [String] project_id # The cloud project # @param [String] history_id @@ -1159,10 +662,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1175,8 +676,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_history_execution_step_perf_sample_series(project_id, history_id, execution_id, step_id, sample_series_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}', options) + def get_perf_sample_series(project_id, history_id, execution_id, step_id, sample_series_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}', options) command.response_representation = Google::Apis::ToolresultsV1beta3::PerfSampleSeries::Representation command.response_class = Google::Apis::ToolresultsV1beta3::PerfSampleSeries command.params['projectId'] = project_id unless project_id.nil? @@ -1186,16 +687,15 @@ module Google command.params['sampleSeriesId'] = sample_series_id unless sample_series_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Lists PerfSampleSeries for a given Step. # The request provides an optional filter which specifies one or more - # PerfMetricsType to include in the result; if none returns all. The resulting - # PerfSampleSeries are sorted by ids. - # May return any of the following canonical error codes: - NOT_FOUND - The - # containing Step does not exist + # PerfMetricsType to include in the result; if none returns all. + # The resulting PerfSampleSeries are sorted by ids. + # May return any of the following canonical error codes: + # - NOT_FOUND - The containing Step does not exist # @param [String] project_id # The cloud project # @param [String] history_id @@ -1209,10 +709,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1225,8 +723,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_history_execution_step_perf_sample_series(project_id, history_id, execution_id, step_id, filter: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries', options) + def list_perf_sample_series(project_id, history_id, execution_id, step_id, filter: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries', options) command.response_representation = Google::Apis::ToolresultsV1beta3::ListPerfSampleSeriesResponse::Representation command.response_class = Google::Apis::ToolresultsV1beta3::ListPerfSampleSeriesResponse command.params['projectId'] = project_id unless project_id.nil? @@ -1236,18 +734,103 @@ module Google command.query['filter'] = filter unless filter.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Creates a batch of PerfSamples - a client can submit multiple batches of Perf - # Samples through repeated calls to this method in order to split up a large - # request payload - duplicates and existing timestamp entries will be ignored. - - # the batch operation may partially succeed - the set of elements successfully - # inserted is returned in the response (omits items which already existed in the - # database). - # May return any of the following canonical error codes: - NOT_FOUND - The - # containing PerfSampleSeries does not exist + # Gets the Tool Results settings for a project. + # May return any of the following canonical error codes: + # - PERMISSION_DENIED - if the user is not authorized to read from project + # @param [String] project_id + # A Project id. + # Required. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ToolresultsV1beta3::ProjectSettings] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ToolresultsV1beta3::ProjectSettings] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_settings(project_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/settings', options) + command.response_representation = Google::Apis::ToolresultsV1beta3::ProjectSettings::Representation + command.response_class = Google::Apis::ToolresultsV1beta3::ProjectSettings + command.params['projectId'] = project_id unless project_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates resources for settings which have not yet been set. + # Currently, this creates a single resource: a Google Cloud Storage bucket, + # to be used as the default bucket for this project. The bucket is created + # in an FTL-own storage project. Except for in rare cases, calling this + # method in parallel from multiple clients will only create a single bucket. + # In order to avoid unnecessary storage charges, the bucket is configured to + # automatically delete objects older than 90 days. + # The bucket is created with the following permissions: + # - Owner access for owners of central storage project (FTL-owned) + # - Writer access for owners/editors of customer project + # - Reader access for viewers of customer project + # The default ACL on objects created in the bucket is: + # - Owner access for owners of central storage project + # - Reader access for owners/editors/viewers of customer project + # See Google Cloud Storage documentation for more details. + # If there is already a default bucket set and the project can access the + # bucket, this call does nothing. However, if the project doesn't have the + # permission to access the bucket or the bucket is deleted, a new bucket + # will be created. + # May return any canonical error codes, including the following: + # - PERMISSION_DENIED - if the user is not authorized to write to project + # - Any error code raised by Google Cloud Storage + # @param [String] project_id + # A Project id. + # Required. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ToolresultsV1beta3::ProjectSettings] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ToolresultsV1beta3::ProjectSettings] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def initialize_project_settings(project_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'toolresults/v1beta3/projects/{projectId}:initializeSettings', options) + command.response_representation = Google::Apis::ToolresultsV1beta3::ProjectSettings::Representation + command.response_class = Google::Apis::ToolresultsV1beta3::ProjectSettings + command.params['projectId'] = project_id unless project_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a batch of PerfSamples + # - a client can submit multiple batches of Perf Samples through repeated + # calls to this method in order to split up a large request payload + # - duplicates and existing timestamp entries will be ignored. + # - the batch operation may partially succeed + # - the set of elements successfully inserted is returned in the response + # (omits items which already existed in the database). + # May return any of the following canonical error codes: + # - NOT_FOUND - The containing PerfSampleSeries does not exist # @param [String] project_id # The cloud project # @param [String] history_id @@ -1262,10 +845,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1278,8 +859,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def batch_create_perf_samples(project_id, history_id, execution_id, step_id, sample_series_id, batch_create_perf_samples_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples:batchCreate', options) + def batch_create_perf_samples(project_id, history_id, execution_id, step_id, sample_series_id, batch_create_perf_samples_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples:batchCreate', options) command.request_representation = Google::Apis::ToolresultsV1beta3::BatchCreatePerfSamplesRequest::Representation command.request_object = batch_create_perf_samples_request_object command.response_representation = Google::Apis::ToolresultsV1beta3::BatchCreatePerfSamplesResponse::Representation @@ -1291,19 +872,19 @@ module Google command.params['sampleSeriesId'] = sample_series_id unless sample_series_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Lists the Performance Samples of a given Sample Series - The list results are - # sorted by timestamps ascending - The default page size is 500 samples; and - # maximum size allowed 5000 - The response token indicates the last returned - # PerfSample timestamp - When the results size exceeds the page size, submit a - # subsequent request including the page token to return the rest of the samples - # up to the page limit - # May return any of the following canonical error codes: - OUT_OF_RANGE - The - # specified request page_token is out of valid range - NOT_FOUND - The - # containing PerfSampleSeries does not exist + # Lists the Performance Samples of a given Sample Series + # - The list results are sorted by timestamps ascending + # - The default page size is 500 samples; and maximum size allowed 5000 + # - The response token indicates the last returned PerfSample timestamp + # - When the results size exceeds the page size, submit a subsequent request + # including the page token to return the rest of the samples up to the + # page limit + # May return any of the following canonical error codes: + # - OUT_OF_RANGE - The specified request page_token is out of valid range + # - NOT_FOUND - The containing PerfSampleSeries does not exist # @param [String] project_id # The cloud project # @param [String] history_id @@ -1315,17 +896,15 @@ module Google # @param [String] sample_series_id # A sample series id # @param [Fixnum] page_size - # The default page size is 500 samples, and the maximum size is 5000. If the - # page_size is greater than 5000, the effective page size will be 5000 + # The default page size is 500 samples, and the maximum size is 5000. If + # the page_size is greater than 5000, the effective page size will be 5000 # @param [String] page_token # Optional, the next_page_token returned in the previous response # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1338,8 +917,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_history_execution_step_perf_sample_series_samples(project_id, history_id, execution_id, step_id, sample_series_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples', options) + def list_samples(project_id, history_id, execution_id, step_id, sample_series_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples', options) command.response_representation = Google::Apis::ToolresultsV1beta3::ListPerfSamplesResponse::Representation command.response_class = Google::Apis::ToolresultsV1beta3::ListPerfSamplesResponse command.params['projectId'] = project_id unless project_id.nil? @@ -1351,16 +930,370 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Gets details of a Test Case for a Step. Experimental test cases API. Still in - # active development. + # Lists accessibility clusters for a given Step # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to write to project - - # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing - # Test Case does not exist + # - PERMISSION_DENIED - if the user is not authorized to read project + # - INVALID_ARGUMENT - if the request is malformed + # - FAILED_PRECONDITION - if an argument in the request happens to be + # invalid; e.g. if the locale format is incorrect + # - NOT_FOUND - if the containing Step does not exist + # @param [String] name + # A full resource name of the step. + # For example, projects/my-project/histories/bh.1234567890abcdef/executions/ + # 1234567890123456789/steps/bs.1234567890abcdef + # Required. + # @param [String] locale + # The accepted format is the canonical Unicode format with hyphen as a + # delimiter. Language must be lowercase, Language Script - Capitalized, + # Region - UPPERCASE. + # See http://www.unicode.org/reports/tr35/#Unicode_locale_identifier for + # details. + # Required. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ToolresultsV1beta3::ListStepAccessibilityClustersResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ToolresultsV1beta3::ListStepAccessibilityClustersResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def accessibility_step_clusters(name, locale: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'toolresults/v1beta3/{+name}:accessibilityClusters', options) + command.response_representation = Google::Apis::ToolresultsV1beta3::ListStepAccessibilityClustersResponse::Representation + command.response_class = Google::Apis::ToolresultsV1beta3::ListStepAccessibilityClustersResponse + command.params['name'] = name unless name.nil? + command.query['locale'] = locale unless locale.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a Step. + # The returned Step will have the id set. + # May return any of the following canonical error codes: + # - PERMISSION_DENIED - if the user is not authorized to write to project + # - INVALID_ARGUMENT - if the request is malformed + # - FAILED_PRECONDITION - if the step is too large (more than 10Mib) + # - NOT_FOUND - if the containing Execution does not exist + # @param [String] project_id + # Required. A Project id. + # @param [String] history_id + # Required. A History id. + # @param [String] execution_id + # Required. An Execution id. + # @param [Google::Apis::ToolresultsV1beta3::Step] step_object + # @param [String] request_id + # A unique request ID for server to detect duplicated requests. + # For example, a UUID. + # Optional, but strongly recommended. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ToolresultsV1beta3::Step] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ToolresultsV1beta3::Step] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_step(project_id, history_id, execution_id, step_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps', options) + command.request_representation = Google::Apis::ToolresultsV1beta3::Step::Representation + command.request_object = step_object + command.response_representation = Google::Apis::ToolresultsV1beta3::Step::Representation + command.response_class = Google::Apis::ToolresultsV1beta3::Step + command.params['projectId'] = project_id unless project_id.nil? + command.params['historyId'] = history_id unless history_id.nil? + command.params['executionId'] = execution_id unless execution_id.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a Step. + # May return any of the following canonical error codes: + # - PERMISSION_DENIED - if the user is not authorized to read project + # - INVALID_ARGUMENT - if the request is malformed + # - NOT_FOUND - if the Step does not exist + # @param [String] project_id + # A Project id. + # Required. + # @param [String] history_id + # A History id. + # Required. + # @param [String] execution_id + # A Execution id. + # Required. + # @param [String] step_id + # A Step id. + # Required. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ToolresultsV1beta3::Step] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ToolresultsV1beta3::Step] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_step(project_id, history_id, execution_id, step_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}', options) + command.response_representation = Google::Apis::ToolresultsV1beta3::Step::Representation + command.response_class = Google::Apis::ToolresultsV1beta3::Step + command.params['projectId'] = project_id unless project_id.nil? + command.params['historyId'] = history_id unless history_id.nil? + command.params['executionId'] = execution_id unless execution_id.nil? + command.params['stepId'] = step_id unless step_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a PerfMetricsSummary. + # May return any of the following error code(s): + # - NOT_FOUND - The specified PerfMetricsSummary does not exist + # @param [String] project_id + # The cloud project + # @param [String] history_id + # A tool results history ID. + # @param [String] execution_id + # A tool results execution ID. + # @param [String] step_id + # A tool results step ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ToolresultsV1beta3::PerfMetricsSummary] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ToolresultsV1beta3::PerfMetricsSummary] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_step_perf_metrics_summary(project_id, history_id, execution_id, step_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfMetricsSummary', options) + command.response_representation = Google::Apis::ToolresultsV1beta3::PerfMetricsSummary::Representation + command.response_class = Google::Apis::ToolresultsV1beta3::PerfMetricsSummary + command.params['projectId'] = project_id unless project_id.nil? + command.params['historyId'] = history_id unless history_id.nil? + command.params['executionId'] = execution_id unless execution_id.nil? + command.params['stepId'] = step_id unless step_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists Steps for a given Execution. + # The steps are sorted by creation_time in descending order. The + # step_id key will be used to order the steps with the same + # creation_time. + # May return any of the following canonical error codes: + # - PERMISSION_DENIED - if the user is not authorized to read project + # - INVALID_ARGUMENT - if the request is malformed + # - FAILED_PRECONDITION - if an argument in the request happens to be + # invalid; e.g. if an attempt is made to list the + # children of a nonexistent Step + # - NOT_FOUND - if the containing Execution does not exist + # @param [String] project_id + # A Project id. + # Required. + # @param [String] history_id + # A History id. + # Required. + # @param [String] execution_id + # A Execution id. + # Required. + # @param [Fixnum] page_size + # The maximum number of Steps to fetch. + # Default value: 25. The server will use this default if the field is not set + # or has a value of 0. + # Optional. + # @param [String] page_token + # A continuation token to resume the query at the next item. + # Optional. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ToolresultsV1beta3::ListStepsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ToolresultsV1beta3::ListStepsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_steps(project_id, history_id, execution_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps', options) + command.response_representation = Google::Apis::ToolresultsV1beta3::ListStepsResponse::Representation + command.response_class = Google::Apis::ToolresultsV1beta3::ListStepsResponse + command.params['projectId'] = project_id unless project_id.nil? + command.params['historyId'] = history_id unless history_id.nil? + command.params['executionId'] = execution_id unless execution_id.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing Step with the supplied partial entity. + # May return any of the following canonical error codes: + # - PERMISSION_DENIED - if the user is not authorized to write project + # - INVALID_ARGUMENT - if the request is malformed + # - FAILED_PRECONDITION - if the requested state transition is illegal + # (e.g try to upload a duplicate xml file), if the + # updated step is too large (more than 10Mib) + # - NOT_FOUND - if the containing Execution does not exist + # @param [String] project_id + # A Project id. + # Required. + # @param [String] history_id + # A History id. + # Required. + # @param [String] execution_id + # A Execution id. + # Required. + # @param [String] step_id + # A Step id. + # Required. + # @param [Google::Apis::ToolresultsV1beta3::Step] step_object + # @param [String] request_id + # A unique request ID for server to detect duplicated requests. + # For example, a UUID. + # Optional, but strongly recommended. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ToolresultsV1beta3::Step] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ToolresultsV1beta3::Step] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_step(project_id, history_id, execution_id, step_id, step_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}', options) + command.request_representation = Google::Apis::ToolresultsV1beta3::Step::Representation + command.request_object = step_object + command.response_representation = Google::Apis::ToolresultsV1beta3::Step::Representation + command.response_class = Google::Apis::ToolresultsV1beta3::Step + command.params['projectId'] = project_id unless project_id.nil? + command.params['historyId'] = history_id unless history_id.nil? + command.params['executionId'] = execution_id unless execution_id.nil? + command.params['stepId'] = step_id unless step_id.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Publish xml files to an existing Step. + # May return any of the following canonical error codes: + # - PERMISSION_DENIED - if the user is not authorized to write project + # - INVALID_ARGUMENT - if the request is malformed + # - FAILED_PRECONDITION - if the requested state transition is illegal, + # e.g try to upload a duplicate xml file or a file too large. + # - NOT_FOUND - if the containing Execution does not exist + # @param [String] project_id + # A Project id. + # Required. + # @param [String] history_id + # A History id. + # Required. + # @param [String] execution_id + # A Execution id. + # Required. + # @param [String] step_id + # A Step id. + # Note: This step must include a TestExecutionStep. + # Required. + # @param [Google::Apis::ToolresultsV1beta3::PublishXunitXmlFilesRequest] publish_xunit_xml_files_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ToolresultsV1beta3::Step] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ToolresultsV1beta3::Step] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def publish_step_xunit_xml_files(project_id, history_id, execution_id, step_id, publish_xunit_xml_files_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}:publishXunitXmlFiles', options) + command.request_representation = Google::Apis::ToolresultsV1beta3::PublishXunitXmlFilesRequest::Representation + command.request_object = publish_xunit_xml_files_request_object + command.response_representation = Google::Apis::ToolresultsV1beta3::Step::Representation + command.response_class = Google::Apis::ToolresultsV1beta3::Step + command.params['projectId'] = project_id unless project_id.nil? + command.params['historyId'] = history_id unless history_id.nil? + command.params['executionId'] = execution_id unless execution_id.nil? + command.params['stepId'] = step_id unless step_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets details of a Test Case for a Step. + # Experimental test cases API. Still in active development. + # May return any of the following canonical error codes: + # - PERMISSION_DENIED - if the user is not authorized to write to project + # - INVALID_ARGUMENT - if the request is malformed + # - NOT_FOUND - if the containing Test Case does not exist # @param [String] project_id # A Project id. # Required. @@ -1371,7 +1304,8 @@ module Google # A Execution id # Required. # @param [String] step_id - # A Step id. Note: This step must include a TestExecutionStep. + # A Step id. + # Note: This step must include a TestExecutionStep. # Required. # @param [String] test_case_id # A Test Case id. @@ -1379,10 +1313,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1395,8 +1327,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_history_execution_step_test_case(project_id, history_id, execution_id, step_id, test_case_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/testCases/{testCaseId}', options) + def get_test_case(project_id, history_id, execution_id, step_id, test_case_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/testCases/{testCaseId}', options) command.response_representation = Google::Apis::ToolresultsV1beta3::TestCase::Representation command.response_class = Google::Apis::ToolresultsV1beta3::TestCase command.params['projectId'] = project_id unless project_id.nil? @@ -1406,16 +1338,15 @@ module Google command.params['testCaseId'] = test_case_id unless test_case_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Lists Test Cases attached to a Step. Experimental test cases API. Still in - # active development. + # Lists Test Cases attached to a Step. + # Experimental test cases API. Still in active development. # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to write to project - - # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing - # Step does not exist + # - PERMISSION_DENIED - if the user is not authorized to write to project + # - INVALID_ARGUMENT - if the request is malformed + # - NOT_FOUND - if the containing Step does not exist # @param [String] project_id # A Project id. # Required. @@ -1426,12 +1357,13 @@ module Google # A Execution id # Required. # @param [String] step_id - # A Step id. Note: This step must include a TestExecutionStep. + # A Step id. + # Note: This step must include a TestExecutionStep. # Required. # @param [Fixnum] page_size # The maximum number of TestCases to fetch. - # Default value: 100. The server will use this default if the field is not set - # or has a value of 0. + # Default value: 100. The server will use this default if the field is not + # set or has a value of 0. # Optional. # @param [String] page_token # A continuation token to resume the query at the next item. @@ -1439,10 +1371,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1455,8 +1385,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_history_execution_step_test_cases(project_id, history_id, execution_id, step_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/testCases', options) + def list_test_cases(project_id, history_id, execution_id, step_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/testCases', options) command.response_representation = Google::Apis::ToolresultsV1beta3::ListTestCasesResponse::Representation command.response_class = Google::Apis::ToolresultsV1beta3::ListTestCasesResponse command.params['projectId'] = project_id unless project_id.nil? @@ -1467,15 +1397,16 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Lists thumbnails of images attached to a step. - # May return any of the following canonical error codes: - PERMISSION_DENIED - - # if the user is not authorized to read from the project, or from any of the - # images - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the - # step does not exist, or if any of the images do not exist + # May return any of the following canonical error codes: + # - PERMISSION_DENIED - if the user is not authorized to read from the + # project, or from any of the images + # - INVALID_ARGUMENT - if the request is malformed + # - NOT_FOUND - if the step does not exist, or if any of the images + # do not exist # @param [String] project_id # A Project id. # Required. @@ -1490,8 +1421,8 @@ module Google # Required. # @param [Fixnum] page_size # The maximum number of thumbnails to fetch. - # Default value: 50. The server will use this default if the field is not set or - # has a value of 0. + # Default value: 50. The server will use this default if the field is not set + # or has a value of 0. # Optional. # @param [String] page_token # A continuation token to resume the query at the next item. @@ -1499,10 +1430,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1515,8 +1444,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_history_execution_step_thumbnails(project_id, history_id, execution_id, step_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/thumbnails', options) + def list_thumbnails(project_id, history_id, execution_id, step_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/thumbnails', options) command.response_representation = Google::Apis::ToolresultsV1beta3::ListStepThumbnailsResponse::Representation command.response_class = Google::Apis::ToolresultsV1beta3::ListStepThumbnailsResponse command.params['projectId'] = project_id unless project_id.nil? @@ -1527,7 +1456,6 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1536,7 +1464,6 @@ module Google def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? end end end diff --git a/generated/google/apis/vault_v1.rb b/generated/google/apis/vault_v1.rb index 5c1028be6..248fdfbe1 100644 --- a/generated/google/apis/vault_v1.rb +++ b/generated/google/apis/vault_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/vault module VaultV1 VERSION = 'V1' - REVISION = '20200305' + REVISION = '20200416' # Manage your eDiscovery data AUTH_EDISCOVERY = 'https://www.googleapis.com/auth/ediscovery' diff --git a/generated/google/apis/vault_v1/classes.rb b/generated/google/apis/vault_v1/classes.rb index dd4ffe4e3..1281b0f0f 100644 --- a/generated/google/apis/vault_v1/classes.rb +++ b/generated/google/apis/vault_v1/classes.rb @@ -77,7 +77,7 @@ module Google class AddHeldAccountsRequest include Google::Apis::Core::Hashable - # Account ids to identify which accounts to add. Only account_ids or only + # Account IDs to identify which accounts to add. Only account_ids or only # emails should be specified, but not both. # Corresponds to the JSON property `accountIds` # @return [Array] @@ -1050,7 +1050,7 @@ module Google class MatterPermission include Google::Apis::Core::Hashable - # The account id, as provided by Admin SDK. # Corresponds to the JSON property `accountId` # @return [String] @@ -1217,7 +1217,7 @@ module Google class RemoveHeldAccountsRequest include Google::Apis::Core::Hashable - # Account ids to identify HeldAccounts to remove. + # Account IDs to identify HeldAccounts to remove. # Corresponds to the JSON property `accountIds` # @return [Array] attr_accessor :account_ids @@ -1318,7 +1318,7 @@ module Google # @return [String] attr_accessor :display_name - # Output only. The matter id of the associated matter. + # Output only. The matter ID of the associated matter. # The server does not look at this field during create and always uses matter # id in the URL. # Corresponds to the JSON property `matterId` @@ -1353,7 +1353,7 @@ module Google class SharedDriveInfo include Google::Apis::Core::Hashable - # List of Shared drive ids, as provided by Drive API. # Corresponds to the JSON property `sharedDriveIds` # @return [Array] @@ -1412,7 +1412,7 @@ module Google class TeamDriveInfo include Google::Apis::Core::Hashable - # List of Team Drive ids, as provided by Drive API. # Corresponds to the JSON property `teamDriveIds` # @return [Array] diff --git a/generated/google/apis/vault_v1/service.rb b/generated/google/apis/vault_v1/service.rb index 1cca7cd83..56d646616 100644 --- a/generated/google/apis/vault_v1/service.rb +++ b/generated/google/apis/vault_v1/service.rb @@ -350,7 +350,7 @@ module Google # Updates the specified matter. # This updates only the name and description of the matter, identified by - # matter id. Changes to any other fields are ignored. + # matter ID. Changes to any other fields are ignored. # Returns the default view of the matter. # @param [String] matter_id # The matter ID. @@ -890,7 +890,7 @@ module Google # Creates a saved query. # @param [String] matter_id - # The matter id of the parent matter for which the saved query is to be + # The matter ID of the parent matter for which the saved query is to be # created. # @param [Google::Apis::VaultV1::SavedQuery] saved_query_object # @param [String] fields @@ -924,10 +924,10 @@ module Google # Deletes a saved query by Id. # @param [String] matter_id - # The matter id of the parent matter for which the saved query is to be + # The matter ID of the parent matter for which the saved query is to be # deleted. # @param [String] saved_query_id - # Id of the saved query to be deleted. + # ID of the saved query to be deleted. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -958,10 +958,10 @@ module Google # Retrieves a saved query by Id. # @param [String] matter_id - # The matter id of the parent matter for which the saved query is to be + # The matter ID of the parent matter for which the saved query is to be # retrieved. # @param [String] saved_query_id - # Id of the saved query to be retrieved. + # ID of the saved query to be retrieved. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -993,7 +993,7 @@ module Google # Lists saved queries within a matter. An empty page token in # ListSavedQueriesResponse denotes no more saved queries to list. # @param [String] matter_id - # The matter id of the parent matter for which the saved queries are to be + # The matter ID of the parent matter for which the saved queries are to be # retrieved. # @param [Fixnum] page_size # The maximum number of saved queries to return. diff --git a/generated/google/apis/videointelligence_v1.rb b/generated/google/apis/videointelligence_v1.rb index 946dc0fa1..b7690ac7e 100644 --- a/generated/google/apis/videointelligence_v1.rb +++ b/generated/google/apis/videointelligence_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/video-intelligence/docs/ module VideointelligenceV1 VERSION = 'V1' - REVISION = '20200310' + REVISION = '20200423' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/videointelligence_v1/classes.rb b/generated/google/apis/videointelligence_v1/classes.rb index 493038e3e..28e2078aa 100644 --- a/generated/google/apis/videointelligence_v1/classes.rb +++ b/generated/google/apis/videointelligence_v1/classes.rb @@ -53,8 +53,8 @@ module Google attr_accessor :features # The video data bytes. - # If unset, the input video(s) should be specified via `input_uri`. - # If set, `input_uri` should be unset. + # If unset, the input video(s) should be specified via the `input_uri`. + # If set, `input_uri` must be unset. # Corresponds to the JSON property `inputContent` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -62,28 +62,29 @@ module Google # Input video location. Currently, only # [Cloud Storage](https://cloud.google.com/storage/) URIs are - # supported, which must be specified in the following format: + # supported. URIs must be specified in the following format: # `gs://bucket-id/object-id` (other URI formats return # google.rpc.Code.INVALID_ARGUMENT). For more information, see # [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). - # A video URI may include wildcards in `object-id`, and thus identify - # multiple videos. Supported wildcards: '*' to match 0 or more characters; + # To identify multiple videos, a video URI may include wildcards in the + # `object-id`. Supported wildcards: '*' to match 0 or more characters; # '?' to match 1 character. If unset, the input video should be embedded - # in the request as `input_content`. If set, `input_content` should be unset. + # in the request as `input_content`. If set, `input_content` must be unset. # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri # Optional. Cloud region where annotation should take place. Supported cloud - # regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region - # is specified, a region will be determined based on video file location. + # regions are: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no + # region is specified, the region will be determined based on video file + # location. # Corresponds to the JSON property `locationId` # @return [String] attr_accessor :location_id # Optional. Location where the output (in JSON format) should be stored. # Currently, only [Cloud Storage](https://cloud.google.com/storage/) - # URIs are supported, which must be specified in the following format: + # URIs are supported. These must be specified in the following format: # `gs://bucket-id/object-id` (other URI formats return # google.rpc.Code.INVALID_ARGUMENT). For more information, see # [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). @@ -141,7 +142,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -175,7 +176,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -203,7 +204,7 @@ module Google class GoogleCloudVideointelligenceV1Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -243,6 +244,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -250,6 +256,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -305,9 +312,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -327,6 +334,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -337,6 +349,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -348,7 +361,7 @@ module Google # frame-level detection. If not set, it is set to 0.4 by default. The valid # range for this threshold is [0.1, 0.9]. Any value set outside of this # range will be clipped. - # Note: for best results please follow the default threshold. We will update + # Note: For best results, follow the default threshold. We will update # the default threshold everytime when we release a new model. # Corresponds to the JSON property `frameConfidenceThreshold` # @return [Float] @@ -368,19 +381,19 @@ module Google # @return [String] attr_accessor :model - # Whether the video has been shot from a stationary (i.e. non-moving) camera. - # When set to true, might improve detection accuracy for moving objects. - # Should be used with `SHOT_AND_FRAME_MODE` enabled. + # Whether the video has been shot from a stationary (i.e., non-moving) + # camera. When set to true, might improve detection accuracy for moving + # objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. # Corresponds to the JSON property `stationaryCamera` # @return [Boolean] attr_accessor :stationary_camera alias_method :stationary_camera?, :stationary_camera # The confidence threshold we perform filtering on the labels from - # video-level and shot-level detections. If not set, it is set to 0.3 by + # video-level and shot-level detections. If not set, it's set to 0.3 by # default. The valid range for this threshold is [0.1, 0.9]. Any value set # outside of this range will be clipped. - # Note: for best results please follow the default threshold. We will update + # Note: For best results, follow the default threshold. We will update # the default threshold everytime when we release a new model. # Corresponds to the JSON property `videoConfidenceThreshold` # @return [Float] @@ -620,6 +633,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -631,6 +649,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -749,8 +768,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -831,7 +850,7 @@ module Google # the top alternative of the recognition result using a speaker_tag provided # in the WordInfo. # Note: When this is true, we send all the words from the beginning of the - # audio for the top alternative in every consecutive responses. + # audio for the top alternative in every consecutive response. # This is done in order to improve our speaker tags as our models learn to # identify the speakers in the conversation over time. # Corresponds to the JSON property `enableSpeakerDiarization` @@ -913,6 +932,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -921,6 +945,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -1111,7 +1136,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -1206,13 +1231,13 @@ module Google # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made @@ -1471,7 +1496,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -1505,7 +1530,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1533,7 +1558,7 @@ module Google class GoogleCloudVideointelligenceV1beta2Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -1573,6 +1598,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -1580,6 +1610,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -1614,9 +1645,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -1636,6 +1667,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -1646,6 +1682,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -1869,6 +1906,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -1880,6 +1922,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -1931,8 +1974,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -1996,6 +2039,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -2004,6 +2052,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -2164,7 +2213,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -2259,13 +2308,13 @@ module Google # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made @@ -2467,7 +2516,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -2501,7 +2550,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2529,7 +2578,7 @@ module Google class GoogleCloudVideointelligenceV1p1beta1Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -2569,6 +2618,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -2576,6 +2630,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -2610,9 +2665,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -2632,6 +2687,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -2642,6 +2702,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -2865,6 +2926,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -2876,6 +2942,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -2927,8 +2994,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -2992,6 +3059,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -3000,6 +3072,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -3160,7 +3233,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -3255,13 +3328,13 @@ module Google # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p1beta1VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made @@ -3463,7 +3536,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -3497,7 +3570,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3525,7 +3598,7 @@ module Google class GoogleCloudVideointelligenceV1p2beta1Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -3565,6 +3638,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -3572,6 +3650,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -3606,9 +3685,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -3628,6 +3707,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -3638,6 +3722,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -3861,6 +3946,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -3872,6 +3962,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -3923,8 +4014,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -3988,6 +4079,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -3996,6 +4092,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -4156,7 +4253,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -4251,13 +4348,13 @@ module Google # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made @@ -4495,6 +4592,11 @@ module Google # @return [Array] attr_accessor :celebrity_tracks + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4502,6 +4604,7 @@ module Google # Update properties of this object def update!(**args) @celebrity_tracks = args[:celebrity_tracks] if args.key?(:celebrity_tracks) + @version = args[:version] if args.key?(:version) end end @@ -4540,7 +4643,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -4574,7 +4677,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4602,7 +4705,7 @@ module Google class GoogleCloudVideointelligenceV1p3beta1Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -4642,6 +4745,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4649,6 +4757,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -4693,6 +4802,11 @@ module Google # @return [Array] attr_accessor :tracks + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4701,6 +4815,7 @@ module Google def update!(**args) @thumbnail = args[:thumbnail] if args.key?(:thumbnail) @tracks = args[:tracks] if args.key?(:tracks) + @version = args[:version] if args.key?(:version) end end @@ -4709,9 +4824,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -4731,6 +4846,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4741,6 +4861,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -4964,6 +5085,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4975,6 +5101,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -5010,11 +5137,16 @@ module Google class GoogleCloudVideointelligenceV1p3beta1PersonDetectionAnnotation include Google::Apis::Core::Hashable - # The trackes that a person is detected. + # The detected tracks of a person. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -5022,6 +5154,7 @@ module Google # Update properties of this object def update!(**args) @tracks = args[:tracks] if args.key?(:tracks) + @version = args[:version] if args.key?(:version) end end @@ -5070,8 +5203,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -5131,10 +5264,10 @@ module Google # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1StreamingVideoAnnotationResults] attr_accessor :annotation_results - # Cloud Storage URI that stores annotation results of one streaming session. - # It is a directory that can hold multiple files in JSON format. - # Example uri format: - # gs://bucket_id/object_id/cloud_project_name-session_id + # Google Cloud Storage(GCS) URI that stores annotation results of one + # streaming session in JSON format. + # It is the annotation_result_storage_directory + # from the request followed by '/cloud_project_number-session_id'. # Corresponds to the JSON property `annotationResultsUri` # @return [String] attr_accessor :annotation_results_uri @@ -5217,6 +5350,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -5225,6 +5363,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -5385,7 +5524,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -5495,13 +5634,13 @@ module Google # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made diff --git a/generated/google/apis/videointelligence_v1/representations.rb b/generated/google/apis/videointelligence_v1/representations.rb index 72c7e38af..2b0f28f5e 100644 --- a/generated/google/apis/videointelligence_v1/representations.rb +++ b/generated/google/apis/videointelligence_v1/representations.rb @@ -1026,6 +1026,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -1055,6 +1056,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1LabelSegment, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1LabelSegment::Representation + property :version, as: 'version' end end @@ -1135,6 +1137,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1VideoSegment, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -1209,6 +1212,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1TextSegment, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end @@ -1400,6 +1404,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -1422,6 +1427,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2LabelSegment, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2LabelSegment::Representation + property :version, as: 'version' end end @@ -1491,6 +1497,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2VideoSegment, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -1528,6 +1535,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2TextSegment, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end @@ -1691,6 +1699,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p1beta1ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p1beta1ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -1713,6 +1722,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p1beta1LabelSegment, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p1beta1LabelSegment::Representation + property :version, as: 'version' end end @@ -1782,6 +1792,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p1beta1VideoSegment, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p1beta1VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -1819,6 +1830,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p1beta1TextSegment, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p1beta1TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end @@ -1982,6 +1994,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -2004,6 +2017,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1LabelSegment, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1LabelSegment::Representation + property :version, as: 'version' end end @@ -2073,6 +2087,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1VideoSegment, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -2110,6 +2125,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1TextSegment, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end @@ -2254,6 +2270,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :celebrity_tracks, as: 'celebrityTracks', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1CelebrityTrack, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1CelebrityTrack::Representation + property :version, as: 'version' end end @@ -2300,6 +2317,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -2317,6 +2335,7 @@ module Google property :thumbnail, :base64 => true, as: 'thumbnail' collection :tracks, as: 'tracks', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1Track, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1Track::Representation + property :version, as: 'version' end end @@ -2331,6 +2350,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1LabelSegment, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1LabelSegment::Representation + property :version, as: 'version' end end @@ -2400,6 +2420,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1VideoSegment, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -2417,6 +2438,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :tracks, as: 'tracks', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1Track, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1Track::Representation + property :version, as: 'version' end end @@ -2479,6 +2501,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1TextSegment, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end diff --git a/generated/google/apis/videointelligence_v1beta2.rb b/generated/google/apis/videointelligence_v1beta2.rb index 44076c84d..0aabf666f 100644 --- a/generated/google/apis/videointelligence_v1beta2.rb +++ b/generated/google/apis/videointelligence_v1beta2.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/video-intelligence/docs/ module VideointelligenceV1beta2 VERSION = 'V1beta2' - REVISION = '20200310' + REVISION = '20200423' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/videointelligence_v1beta2/classes.rb b/generated/google/apis/videointelligence_v1beta2/classes.rb index 42fcef4c3..625805bfb 100644 --- a/generated/google/apis/videointelligence_v1beta2/classes.rb +++ b/generated/google/apis/videointelligence_v1beta2/classes.rb @@ -73,7 +73,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -107,7 +107,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -135,7 +135,7 @@ module Google class GoogleCloudVideointelligenceV1Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -175,6 +175,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -182,6 +187,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -216,9 +222,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -238,6 +244,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -248,6 +259,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -471,6 +483,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -482,6 +499,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -533,8 +551,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -598,6 +616,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -606,6 +629,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -766,7 +790,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -861,13 +885,13 @@ module Google # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made @@ -1049,8 +1073,8 @@ module Google attr_accessor :features # The video data bytes. - # If unset, the input video(s) should be specified via `input_uri`. - # If set, `input_uri` should be unset. + # If unset, the input video(s) should be specified via the `input_uri`. + # If set, `input_uri` must be unset. # Corresponds to the JSON property `inputContent` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1058,28 +1082,29 @@ module Google # Input video location. Currently, only # [Cloud Storage](https://cloud.google.com/storage/) URIs are - # supported, which must be specified in the following format: + # supported. URIs must be specified in the following format: # `gs://bucket-id/object-id` (other URI formats return # google.rpc.Code.INVALID_ARGUMENT). For more information, see # [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). - # A video URI may include wildcards in `object-id`, and thus identify - # multiple videos. Supported wildcards: '*' to match 0 or more characters; + # To identify multiple videos, a video URI may include wildcards in the + # `object-id`. Supported wildcards: '*' to match 0 or more characters; # '?' to match 1 character. If unset, the input video should be embedded - # in the request as `input_content`. If set, `input_content` should be unset. + # in the request as `input_content`. If set, `input_content` must be unset. # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri # Optional. Cloud region where annotation should take place. Supported cloud - # regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region - # is specified, a region will be determined based on video file location. + # regions are: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no + # region is specified, the region will be determined based on video file + # location. # Corresponds to the JSON property `locationId` # @return [String] attr_accessor :location_id # Optional. Location where the output (in JSON format) should be stored. # Currently, only [Cloud Storage](https://cloud.google.com/storage/) - # URIs are supported, which must be specified in the following format: + # URIs are supported. These must be specified in the following format: # `gs://bucket-id/object-id` (other URI formats return # google.rpc.Code.INVALID_ARGUMENT). For more information, see # [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). @@ -1137,7 +1162,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -1171,7 +1196,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1199,7 +1224,7 @@ module Google class GoogleCloudVideointelligenceV1beta2Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -1239,6 +1264,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -1246,6 +1276,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -1301,9 +1332,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -1323,6 +1354,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -1333,6 +1369,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -1344,7 +1381,7 @@ module Google # frame-level detection. If not set, it is set to 0.4 by default. The valid # range for this threshold is [0.1, 0.9]. Any value set outside of this # range will be clipped. - # Note: for best results please follow the default threshold. We will update + # Note: For best results, follow the default threshold. We will update # the default threshold everytime when we release a new model. # Corresponds to the JSON property `frameConfidenceThreshold` # @return [Float] @@ -1364,19 +1401,19 @@ module Google # @return [String] attr_accessor :model - # Whether the video has been shot from a stationary (i.e. non-moving) camera. - # When set to true, might improve detection accuracy for moving objects. - # Should be used with `SHOT_AND_FRAME_MODE` enabled. + # Whether the video has been shot from a stationary (i.e., non-moving) + # camera. When set to true, might improve detection accuracy for moving + # objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. # Corresponds to the JSON property `stationaryCamera` # @return [Boolean] attr_accessor :stationary_camera alias_method :stationary_camera?, :stationary_camera # The confidence threshold we perform filtering on the labels from - # video-level and shot-level detections. If not set, it is set to 0.3 by + # video-level and shot-level detections. If not set, it's set to 0.3 by # default. The valid range for this threshold is [0.1, 0.9]. Any value set # outside of this range will be clipped. - # Note: for best results please follow the default threshold. We will update + # Note: For best results, follow the default threshold. We will update # the default threshold everytime when we release a new model. # Corresponds to the JSON property `videoConfidenceThreshold` # @return [Float] @@ -1616,6 +1653,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -1627,6 +1669,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -1745,8 +1788,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -1827,7 +1870,7 @@ module Google # the top alternative of the recognition result using a speaker_tag provided # in the WordInfo. # Note: When this is true, we send all the words from the beginning of the - # audio for the top alternative in every consecutive responses. + # audio for the top alternative in every consecutive response. # This is done in order to improve our speaker tags as our models learn to # identify the speakers in the conversation over time. # Corresponds to the JSON property `enableSpeakerDiarization` @@ -1909,6 +1952,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -1917,6 +1965,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -2107,7 +2156,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -2202,13 +2251,13 @@ module Google # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made @@ -2467,7 +2516,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -2501,7 +2550,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2529,7 +2578,7 @@ module Google class GoogleCloudVideointelligenceV1p1beta1Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -2569,6 +2618,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -2576,6 +2630,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -2610,9 +2665,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -2632,6 +2687,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -2642,6 +2702,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -2865,6 +2926,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -2876,6 +2942,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -2927,8 +2994,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -2992,6 +3059,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -3000,6 +3072,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -3160,7 +3233,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -3255,13 +3328,13 @@ module Google # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p1beta1VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made @@ -3463,7 +3536,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -3497,7 +3570,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3525,7 +3598,7 @@ module Google class GoogleCloudVideointelligenceV1p2beta1Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -3565,6 +3638,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -3572,6 +3650,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -3606,9 +3685,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -3628,6 +3707,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -3638,6 +3722,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -3861,6 +3946,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -3872,6 +3962,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -3923,8 +4014,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -3988,6 +4079,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -3996,6 +4092,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -4156,7 +4253,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -4251,13 +4348,13 @@ module Google # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made @@ -4495,6 +4592,11 @@ module Google # @return [Array] attr_accessor :celebrity_tracks + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4502,6 +4604,7 @@ module Google # Update properties of this object def update!(**args) @celebrity_tracks = args[:celebrity_tracks] if args.key?(:celebrity_tracks) + @version = args[:version] if args.key?(:version) end end @@ -4540,7 +4643,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -4574,7 +4677,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4602,7 +4705,7 @@ module Google class GoogleCloudVideointelligenceV1p3beta1Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -4642,6 +4745,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4649,6 +4757,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -4693,6 +4802,11 @@ module Google # @return [Array] attr_accessor :tracks + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4701,6 +4815,7 @@ module Google def update!(**args) @thumbnail = args[:thumbnail] if args.key?(:thumbnail) @tracks = args[:tracks] if args.key?(:tracks) + @version = args[:version] if args.key?(:version) end end @@ -4709,9 +4824,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -4731,6 +4846,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4741,6 +4861,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -4964,6 +5085,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4975,6 +5101,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -5010,11 +5137,16 @@ module Google class GoogleCloudVideointelligenceV1p3beta1PersonDetectionAnnotation include Google::Apis::Core::Hashable - # The trackes that a person is detected. + # The detected tracks of a person. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -5022,6 +5154,7 @@ module Google # Update properties of this object def update!(**args) @tracks = args[:tracks] if args.key?(:tracks) + @version = args[:version] if args.key?(:version) end end @@ -5070,8 +5203,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -5131,10 +5264,10 @@ module Google # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1StreamingVideoAnnotationResults] attr_accessor :annotation_results - # Cloud Storage URI that stores annotation results of one streaming session. - # It is a directory that can hold multiple files in JSON format. - # Example uri format: - # gs://bucket_id/object_id/cloud_project_name-session_id + # Google Cloud Storage(GCS) URI that stores annotation results of one + # streaming session in JSON format. + # It is the annotation_result_storage_directory + # from the request followed by '/cloud_project_number-session_id'. # Corresponds to the JSON property `annotationResultsUri` # @return [String] attr_accessor :annotation_results_uri @@ -5217,6 +5350,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -5225,6 +5363,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -5385,7 +5524,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -5495,13 +5634,13 @@ module Google # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made diff --git a/generated/google/apis/videointelligence_v1beta2/representations.rb b/generated/google/apis/videointelligence_v1beta2/representations.rb index a9216080c..81068ed2e 100644 --- a/generated/google/apis/videointelligence_v1beta2/representations.rb +++ b/generated/google/apis/videointelligence_v1beta2/representations.rb @@ -995,6 +995,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -1017,6 +1018,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1LabelSegment, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1LabelSegment::Representation + property :version, as: 'version' end end @@ -1086,6 +1088,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1VideoSegment, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -1123,6 +1126,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1TextSegment, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end @@ -1299,6 +1303,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -1328,6 +1333,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2LabelSegment, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2LabelSegment::Representation + property :version, as: 'version' end end @@ -1408,6 +1414,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2VideoSegment, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -1482,6 +1489,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2TextSegment, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end @@ -1673,6 +1681,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p1beta1ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p1beta1ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -1695,6 +1704,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p1beta1LabelSegment, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p1beta1LabelSegment::Representation + property :version, as: 'version' end end @@ -1764,6 +1774,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p1beta1VideoSegment, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p1beta1VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -1801,6 +1812,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p1beta1TextSegment, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p1beta1TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end @@ -1964,6 +1976,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -1986,6 +1999,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1LabelSegment, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1LabelSegment::Representation + property :version, as: 'version' end end @@ -2055,6 +2069,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1VideoSegment, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -2092,6 +2107,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1TextSegment, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end @@ -2236,6 +2252,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :celebrity_tracks, as: 'celebrityTracks', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1CelebrityTrack, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1CelebrityTrack::Representation + property :version, as: 'version' end end @@ -2282,6 +2299,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -2299,6 +2317,7 @@ module Google property :thumbnail, :base64 => true, as: 'thumbnail' collection :tracks, as: 'tracks', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1Track, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1Track::Representation + property :version, as: 'version' end end @@ -2313,6 +2332,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1LabelSegment, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1LabelSegment::Representation + property :version, as: 'version' end end @@ -2382,6 +2402,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1VideoSegment, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -2399,6 +2420,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :tracks, as: 'tracks', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1Track, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1Track::Representation + property :version, as: 'version' end end @@ -2461,6 +2483,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1TextSegment, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end diff --git a/generated/google/apis/videointelligence_v1p1beta1.rb b/generated/google/apis/videointelligence_v1p1beta1.rb index f41df3070..8b271242b 100644 --- a/generated/google/apis/videointelligence_v1p1beta1.rb +++ b/generated/google/apis/videointelligence_v1p1beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/video-intelligence/docs/ module VideointelligenceV1p1beta1 VERSION = 'V1p1beta1' - REVISION = '20200310' + REVISION = '20200423' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/videointelligence_v1p1beta1/classes.rb b/generated/google/apis/videointelligence_v1p1beta1/classes.rb index df4749d4b..53f1ec0ad 100644 --- a/generated/google/apis/videointelligence_v1p1beta1/classes.rb +++ b/generated/google/apis/videointelligence_v1p1beta1/classes.rb @@ -73,7 +73,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -107,7 +107,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -135,7 +135,7 @@ module Google class GoogleCloudVideointelligenceV1Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -175,6 +175,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -182,6 +187,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -216,9 +222,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -238,6 +244,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -248,6 +259,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -471,6 +483,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -482,6 +499,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -533,8 +551,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -598,6 +616,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -606,6 +629,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -766,7 +790,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -861,13 +885,13 @@ module Google # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made @@ -1069,7 +1093,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -1103,7 +1127,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1131,7 +1155,7 @@ module Google class GoogleCloudVideointelligenceV1beta2Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -1171,6 +1195,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -1178,6 +1207,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -1212,9 +1242,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -1234,6 +1264,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -1244,6 +1279,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -1467,6 +1503,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -1478,6 +1519,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -1529,8 +1571,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -1594,6 +1636,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -1602,6 +1649,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -1762,7 +1810,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -1857,13 +1905,13 @@ module Google # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made @@ -2045,8 +2093,8 @@ module Google attr_accessor :features # The video data bytes. - # If unset, the input video(s) should be specified via `input_uri`. - # If set, `input_uri` should be unset. + # If unset, the input video(s) should be specified via the `input_uri`. + # If set, `input_uri` must be unset. # Corresponds to the JSON property `inputContent` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -2054,28 +2102,29 @@ module Google # Input video location. Currently, only # [Cloud Storage](https://cloud.google.com/storage/) URIs are - # supported, which must be specified in the following format: + # supported. URIs must be specified in the following format: # `gs://bucket-id/object-id` (other URI formats return # google.rpc.Code.INVALID_ARGUMENT). For more information, see # [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). - # A video URI may include wildcards in `object-id`, and thus identify - # multiple videos. Supported wildcards: '*' to match 0 or more characters; + # To identify multiple videos, a video URI may include wildcards in the + # `object-id`. Supported wildcards: '*' to match 0 or more characters; # '?' to match 1 character. If unset, the input video should be embedded - # in the request as `input_content`. If set, `input_content` should be unset. + # in the request as `input_content`. If set, `input_content` must be unset. # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri # Optional. Cloud region where annotation should take place. Supported cloud - # regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region - # is specified, a region will be determined based on video file location. + # regions are: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no + # region is specified, the region will be determined based on video file + # location. # Corresponds to the JSON property `locationId` # @return [String] attr_accessor :location_id # Optional. Location where the output (in JSON format) should be stored. # Currently, only [Cloud Storage](https://cloud.google.com/storage/) - # URIs are supported, which must be specified in the following format: + # URIs are supported. These must be specified in the following format: # `gs://bucket-id/object-id` (other URI formats return # google.rpc.Code.INVALID_ARGUMENT). For more information, see # [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). @@ -2133,7 +2182,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -2167,7 +2216,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2195,7 +2244,7 @@ module Google class GoogleCloudVideointelligenceV1p1beta1Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -2235,6 +2284,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -2242,6 +2296,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -2297,9 +2352,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -2319,6 +2374,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -2329,6 +2389,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -2340,7 +2401,7 @@ module Google # frame-level detection. If not set, it is set to 0.4 by default. The valid # range for this threshold is [0.1, 0.9]. Any value set outside of this # range will be clipped. - # Note: for best results please follow the default threshold. We will update + # Note: For best results, follow the default threshold. We will update # the default threshold everytime when we release a new model. # Corresponds to the JSON property `frameConfidenceThreshold` # @return [Float] @@ -2360,19 +2421,19 @@ module Google # @return [String] attr_accessor :model - # Whether the video has been shot from a stationary (i.e. non-moving) camera. - # When set to true, might improve detection accuracy for moving objects. - # Should be used with `SHOT_AND_FRAME_MODE` enabled. + # Whether the video has been shot from a stationary (i.e., non-moving) + # camera. When set to true, might improve detection accuracy for moving + # objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. # Corresponds to the JSON property `stationaryCamera` # @return [Boolean] attr_accessor :stationary_camera alias_method :stationary_camera?, :stationary_camera # The confidence threshold we perform filtering on the labels from - # video-level and shot-level detections. If not set, it is set to 0.3 by + # video-level and shot-level detections. If not set, it's set to 0.3 by # default. The valid range for this threshold is [0.1, 0.9]. Any value set # outside of this range will be clipped. - # Note: for best results please follow the default threshold. We will update + # Note: For best results, follow the default threshold. We will update # the default threshold everytime when we release a new model. # Corresponds to the JSON property `videoConfidenceThreshold` # @return [Float] @@ -2612,6 +2673,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -2623,6 +2689,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -2741,8 +2808,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -2823,7 +2890,7 @@ module Google # the top alternative of the recognition result using a speaker_tag provided # in the WordInfo. # Note: When this is true, we send all the words from the beginning of the - # audio for the top alternative in every consecutive responses. + # audio for the top alternative in every consecutive response. # This is done in order to improve our speaker tags as our models learn to # identify the speakers in the conversation over time. # Corresponds to the JSON property `enableSpeakerDiarization` @@ -2905,6 +2972,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -2913,6 +2985,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -3103,7 +3176,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -3198,13 +3271,13 @@ module Google # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p1beta1VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made @@ -3463,7 +3536,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -3497,7 +3570,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3525,7 +3598,7 @@ module Google class GoogleCloudVideointelligenceV1p2beta1Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -3565,6 +3638,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -3572,6 +3650,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -3606,9 +3685,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -3628,6 +3707,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -3638,6 +3722,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -3861,6 +3946,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -3872,6 +3962,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -3923,8 +4014,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -3988,6 +4079,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -3996,6 +4092,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -4156,7 +4253,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -4251,13 +4348,13 @@ module Google # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made @@ -4495,6 +4592,11 @@ module Google # @return [Array] attr_accessor :celebrity_tracks + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4502,6 +4604,7 @@ module Google # Update properties of this object def update!(**args) @celebrity_tracks = args[:celebrity_tracks] if args.key?(:celebrity_tracks) + @version = args[:version] if args.key?(:version) end end @@ -4540,7 +4643,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -4574,7 +4677,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4602,7 +4705,7 @@ module Google class GoogleCloudVideointelligenceV1p3beta1Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -4642,6 +4745,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4649,6 +4757,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -4693,6 +4802,11 @@ module Google # @return [Array] attr_accessor :tracks + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4701,6 +4815,7 @@ module Google def update!(**args) @thumbnail = args[:thumbnail] if args.key?(:thumbnail) @tracks = args[:tracks] if args.key?(:tracks) + @version = args[:version] if args.key?(:version) end end @@ -4709,9 +4824,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -4731,6 +4846,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4741,6 +4861,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -4964,6 +5085,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4975,6 +5101,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -5010,11 +5137,16 @@ module Google class GoogleCloudVideointelligenceV1p3beta1PersonDetectionAnnotation include Google::Apis::Core::Hashable - # The trackes that a person is detected. + # The detected tracks of a person. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -5022,6 +5154,7 @@ module Google # Update properties of this object def update!(**args) @tracks = args[:tracks] if args.key?(:tracks) + @version = args[:version] if args.key?(:version) end end @@ -5070,8 +5203,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -5131,10 +5264,10 @@ module Google # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1StreamingVideoAnnotationResults] attr_accessor :annotation_results - # Cloud Storage URI that stores annotation results of one streaming session. - # It is a directory that can hold multiple files in JSON format. - # Example uri format: - # gs://bucket_id/object_id/cloud_project_name-session_id + # Google Cloud Storage(GCS) URI that stores annotation results of one + # streaming session in JSON format. + # It is the annotation_result_storage_directory + # from the request followed by '/cloud_project_number-session_id'. # Corresponds to the JSON property `annotationResultsUri` # @return [String] attr_accessor :annotation_results_uri @@ -5217,6 +5350,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -5225,6 +5363,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -5385,7 +5524,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -5495,13 +5634,13 @@ module Google # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made diff --git a/generated/google/apis/videointelligence_v1p1beta1/representations.rb b/generated/google/apis/videointelligence_v1p1beta1/representations.rb index e4354e899..5f30c1924 100644 --- a/generated/google/apis/videointelligence_v1p1beta1/representations.rb +++ b/generated/google/apis/videointelligence_v1p1beta1/representations.rb @@ -995,6 +995,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -1017,6 +1018,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1LabelSegment, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1LabelSegment::Representation + property :version, as: 'version' end end @@ -1086,6 +1088,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1VideoSegment, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -1123,6 +1126,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1TextSegment, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end @@ -1286,6 +1290,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -1308,6 +1313,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2LabelSegment, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2LabelSegment::Representation + property :version, as: 'version' end end @@ -1377,6 +1383,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2VideoSegment, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -1414,6 +1421,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2TextSegment, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end @@ -1590,6 +1598,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p1beta1ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p1beta1ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -1619,6 +1628,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p1beta1LabelSegment, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p1beta1LabelSegment::Representation + property :version, as: 'version' end end @@ -1699,6 +1709,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p1beta1VideoSegment, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p1beta1VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -1773,6 +1784,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p1beta1TextSegment, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p1beta1TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end @@ -1964,6 +1976,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -1986,6 +1999,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1LabelSegment, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1LabelSegment::Representation + property :version, as: 'version' end end @@ -2055,6 +2069,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1VideoSegment, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -2092,6 +2107,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1TextSegment, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end @@ -2236,6 +2252,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :celebrity_tracks, as: 'celebrityTracks', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1CelebrityTrack, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1CelebrityTrack::Representation + property :version, as: 'version' end end @@ -2282,6 +2299,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -2299,6 +2317,7 @@ module Google property :thumbnail, :base64 => true, as: 'thumbnail' collection :tracks, as: 'tracks', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1Track, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1Track::Representation + property :version, as: 'version' end end @@ -2313,6 +2332,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1LabelSegment, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1LabelSegment::Representation + property :version, as: 'version' end end @@ -2382,6 +2402,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1VideoSegment, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -2399,6 +2420,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :tracks, as: 'tracks', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1Track, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1Track::Representation + property :version, as: 'version' end end @@ -2461,6 +2483,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1TextSegment, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end diff --git a/generated/google/apis/videointelligence_v1p2beta1.rb b/generated/google/apis/videointelligence_v1p2beta1.rb index 5738da6ca..fb3679b25 100644 --- a/generated/google/apis/videointelligence_v1p2beta1.rb +++ b/generated/google/apis/videointelligence_v1p2beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/video-intelligence/docs/ module VideointelligenceV1p2beta1 VERSION = 'V1p2beta1' - REVISION = '20200310' + REVISION = '20200423' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/videointelligence_v1p2beta1/classes.rb b/generated/google/apis/videointelligence_v1p2beta1/classes.rb index a6400238a..b856a33b0 100644 --- a/generated/google/apis/videointelligence_v1p2beta1/classes.rb +++ b/generated/google/apis/videointelligence_v1p2beta1/classes.rb @@ -73,7 +73,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -107,7 +107,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -135,7 +135,7 @@ module Google class GoogleCloudVideointelligenceV1Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -175,6 +175,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -182,6 +187,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -216,9 +222,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -238,6 +244,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -248,6 +259,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -471,6 +483,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -482,6 +499,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -533,8 +551,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -598,6 +616,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -606,6 +629,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -766,7 +790,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -861,13 +885,13 @@ module Google # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made @@ -1069,7 +1093,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -1103,7 +1127,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1131,7 +1155,7 @@ module Google class GoogleCloudVideointelligenceV1beta2Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -1171,6 +1195,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -1178,6 +1207,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -1212,9 +1242,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -1234,6 +1264,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -1244,6 +1279,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -1467,6 +1503,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -1478,6 +1519,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -1529,8 +1571,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -1594,6 +1636,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -1602,6 +1649,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -1762,7 +1810,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -1857,13 +1905,13 @@ module Google # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1beta2VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made @@ -2065,7 +2113,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -2099,7 +2147,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2127,7 +2175,7 @@ module Google class GoogleCloudVideointelligenceV1p1beta1Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -2167,6 +2215,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -2174,6 +2227,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -2208,9 +2262,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -2230,6 +2284,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -2240,6 +2299,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -2463,6 +2523,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -2474,6 +2539,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -2525,8 +2591,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -2590,6 +2656,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -2598,6 +2669,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -2758,7 +2830,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -2853,13 +2925,13 @@ module Google # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p1beta1VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made @@ -3041,8 +3113,8 @@ module Google attr_accessor :features # The video data bytes. - # If unset, the input video(s) should be specified via `input_uri`. - # If set, `input_uri` should be unset. + # If unset, the input video(s) should be specified via the `input_uri`. + # If set, `input_uri` must be unset. # Corresponds to the JSON property `inputContent` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -3050,28 +3122,29 @@ module Google # Input video location. Currently, only # [Cloud Storage](https://cloud.google.com/storage/) URIs are - # supported, which must be specified in the following format: + # supported. URIs must be specified in the following format: # `gs://bucket-id/object-id` (other URI formats return # google.rpc.Code.INVALID_ARGUMENT). For more information, see # [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). - # A video URI may include wildcards in `object-id`, and thus identify - # multiple videos. Supported wildcards: '*' to match 0 or more characters; + # To identify multiple videos, a video URI may include wildcards in the + # `object-id`. Supported wildcards: '*' to match 0 or more characters; # '?' to match 1 character. If unset, the input video should be embedded - # in the request as `input_content`. If set, `input_content` should be unset. + # in the request as `input_content`. If set, `input_content` must be unset. # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri # Optional. Cloud region where annotation should take place. Supported cloud - # regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region - # is specified, a region will be determined based on video file location. + # regions are: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no + # region is specified, the region will be determined based on video file + # location. # Corresponds to the JSON property `locationId` # @return [String] attr_accessor :location_id # Optional. Location where the output (in JSON format) should be stored. # Currently, only [Cloud Storage](https://cloud.google.com/storage/) - # URIs are supported, which must be specified in the following format: + # URIs are supported. These must be specified in the following format: # `gs://bucket-id/object-id` (other URI formats return # google.rpc.Code.INVALID_ARGUMENT). For more information, see # [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). @@ -3129,7 +3202,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -3163,7 +3236,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3191,7 +3264,7 @@ module Google class GoogleCloudVideointelligenceV1p2beta1Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -3231,6 +3304,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -3238,6 +3316,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -3293,9 +3372,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -3315,6 +3394,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -3325,6 +3409,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -3336,7 +3421,7 @@ module Google # frame-level detection. If not set, it is set to 0.4 by default. The valid # range for this threshold is [0.1, 0.9]. Any value set outside of this # range will be clipped. - # Note: for best results please follow the default threshold. We will update + # Note: For best results, follow the default threshold. We will update # the default threshold everytime when we release a new model. # Corresponds to the JSON property `frameConfidenceThreshold` # @return [Float] @@ -3356,19 +3441,19 @@ module Google # @return [String] attr_accessor :model - # Whether the video has been shot from a stationary (i.e. non-moving) camera. - # When set to true, might improve detection accuracy for moving objects. - # Should be used with `SHOT_AND_FRAME_MODE` enabled. + # Whether the video has been shot from a stationary (i.e., non-moving) + # camera. When set to true, might improve detection accuracy for moving + # objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. # Corresponds to the JSON property `stationaryCamera` # @return [Boolean] attr_accessor :stationary_camera alias_method :stationary_camera?, :stationary_camera # The confidence threshold we perform filtering on the labels from - # video-level and shot-level detections. If not set, it is set to 0.3 by + # video-level and shot-level detections. If not set, it's set to 0.3 by # default. The valid range for this threshold is [0.1, 0.9]. Any value set # outside of this range will be clipped. - # Note: for best results please follow the default threshold. We will update + # Note: For best results, follow the default threshold. We will update # the default threshold everytime when we release a new model. # Corresponds to the JSON property `videoConfidenceThreshold` # @return [Float] @@ -3608,6 +3693,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -3619,6 +3709,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -3737,8 +3828,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -3819,7 +3910,7 @@ module Google # the top alternative of the recognition result using a speaker_tag provided # in the WordInfo. # Note: When this is true, we send all the words from the beginning of the - # audio for the top alternative in every consecutive responses. + # audio for the top alternative in every consecutive response. # This is done in order to improve our speaker tags as our models learn to # identify the speakers in the conversation over time. # Corresponds to the JSON property `enableSpeakerDiarization` @@ -3901,6 +3992,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -3909,6 +4005,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -4099,7 +4196,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -4194,13 +4291,13 @@ module Google # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p2beta1VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made @@ -4495,6 +4592,11 @@ module Google # @return [Array] attr_accessor :celebrity_tracks + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4502,6 +4604,7 @@ module Google # Update properties of this object def update!(**args) @celebrity_tracks = args[:celebrity_tracks] if args.key?(:celebrity_tracks) + @version = args[:version] if args.key?(:version) end end @@ -4540,7 +4643,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -4574,7 +4677,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4602,7 +4705,7 @@ module Google class GoogleCloudVideointelligenceV1p3beta1Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -4642,6 +4745,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4649,6 +4757,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -4693,6 +4802,11 @@ module Google # @return [Array] attr_accessor :tracks + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4701,6 +4815,7 @@ module Google def update!(**args) @thumbnail = args[:thumbnail] if args.key?(:thumbnail) @tracks = args[:tracks] if args.key?(:tracks) + @version = args[:version] if args.key?(:version) end end @@ -4709,9 +4824,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -4731,6 +4846,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4741,6 +4861,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -4964,6 +5085,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4975,6 +5101,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -5010,11 +5137,16 @@ module Google class GoogleCloudVideointelligenceV1p3beta1PersonDetectionAnnotation include Google::Apis::Core::Hashable - # The trackes that a person is detected. + # The detected tracks of a person. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -5022,6 +5154,7 @@ module Google # Update properties of this object def update!(**args) @tracks = args[:tracks] if args.key?(:tracks) + @version = args[:version] if args.key?(:version) end end @@ -5070,8 +5203,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -5131,10 +5264,10 @@ module Google # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1StreamingVideoAnnotationResults] attr_accessor :annotation_results - # Cloud Storage URI that stores annotation results of one streaming session. - # It is a directory that can hold multiple files in JSON format. - # Example uri format: - # gs://bucket_id/object_id/cloud_project_name-session_id + # Google Cloud Storage(GCS) URI that stores annotation results of one + # streaming session in JSON format. + # It is the annotation_result_storage_directory + # from the request followed by '/cloud_project_number-session_id'. # Corresponds to the JSON property `annotationResultsUri` # @return [String] attr_accessor :annotation_results_uri @@ -5217,6 +5350,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -5225,6 +5363,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -5385,7 +5524,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -5495,13 +5634,13 @@ module Google # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made diff --git a/generated/google/apis/videointelligence_v1p2beta1/representations.rb b/generated/google/apis/videointelligence_v1p2beta1/representations.rb index 124be7924..2084fb1b0 100644 --- a/generated/google/apis/videointelligence_v1p2beta1/representations.rb +++ b/generated/google/apis/videointelligence_v1p2beta1/representations.rb @@ -995,6 +995,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -1017,6 +1018,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1LabelSegment, decorator: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1LabelSegment::Representation + property :version, as: 'version' end end @@ -1086,6 +1088,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1VideoSegment, decorator: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -1123,6 +1126,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1TextSegment, decorator: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end @@ -1286,6 +1290,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1beta2ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1beta2ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -1308,6 +1313,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1beta2LabelSegment, decorator: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1beta2LabelSegment::Representation + property :version, as: 'version' end end @@ -1377,6 +1383,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1beta2VideoSegment, decorator: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1beta2VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -1414,6 +1421,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1beta2TextSegment, decorator: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1beta2TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end @@ -1577,6 +1585,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p1beta1ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p1beta1ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -1599,6 +1608,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p1beta1LabelSegment, decorator: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p1beta1LabelSegment::Representation + property :version, as: 'version' end end @@ -1668,6 +1678,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p1beta1VideoSegment, decorator: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p1beta1VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -1705,6 +1716,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p1beta1TextSegment, decorator: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p1beta1TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end @@ -1881,6 +1893,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p2beta1ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p2beta1ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -1910,6 +1923,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p2beta1LabelSegment, decorator: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p2beta1LabelSegment::Representation + property :version, as: 'version' end end @@ -1990,6 +2004,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p2beta1VideoSegment, decorator: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p2beta1VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -2064,6 +2079,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p2beta1TextSegment, decorator: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p2beta1TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end @@ -2236,6 +2252,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :celebrity_tracks, as: 'celebrityTracks', class: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1CelebrityTrack, decorator: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1CelebrityTrack::Representation + property :version, as: 'version' end end @@ -2282,6 +2299,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -2299,6 +2317,7 @@ module Google property :thumbnail, :base64 => true, as: 'thumbnail' collection :tracks, as: 'tracks', class: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1Track, decorator: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1Track::Representation + property :version, as: 'version' end end @@ -2313,6 +2332,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1LabelSegment, decorator: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1LabelSegment::Representation + property :version, as: 'version' end end @@ -2382,6 +2402,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1VideoSegment, decorator: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -2399,6 +2420,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :tracks, as: 'tracks', class: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1Track, decorator: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1Track::Representation + property :version, as: 'version' end end @@ -2461,6 +2483,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1TextSegment, decorator: Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end diff --git a/generated/google/apis/videointelligence_v1p3beta1.rb b/generated/google/apis/videointelligence_v1p3beta1.rb index aa543225d..214971f38 100644 --- a/generated/google/apis/videointelligence_v1p3beta1.rb +++ b/generated/google/apis/videointelligence_v1p3beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/video-intelligence/docs/ module VideointelligenceV1p3beta1 VERSION = 'V1p3beta1' - REVISION = '20200310' + REVISION = '20200423' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/videointelligence_v1p3beta1/classes.rb b/generated/google/apis/videointelligence_v1p3beta1/classes.rb index 57f3cc640..0e46e7c8c 100644 --- a/generated/google/apis/videointelligence_v1p3beta1/classes.rb +++ b/generated/google/apis/videointelligence_v1p3beta1/classes.rb @@ -73,7 +73,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -107,7 +107,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -135,7 +135,7 @@ module Google class GoogleCloudVideointelligenceV1Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -175,6 +175,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -182,6 +187,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -216,9 +222,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -238,6 +244,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -248,6 +259,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -471,6 +483,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -482,6 +499,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -533,8 +551,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -598,6 +616,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -606,6 +629,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -766,7 +790,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -861,13 +885,13 @@ module Google # @return [Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made @@ -1069,7 +1093,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -1103,7 +1127,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1131,7 +1155,7 @@ module Google class GoogleCloudVideointelligenceV1beta2Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -1171,6 +1195,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -1178,6 +1207,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -1212,9 +1242,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -1234,6 +1264,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -1244,6 +1279,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -1467,6 +1503,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -1478,6 +1519,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -1529,8 +1571,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -1594,6 +1636,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -1602,6 +1649,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -1762,7 +1810,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -1857,13 +1905,13 @@ module Google # @return [Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1beta2VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made @@ -2065,7 +2113,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -2099,7 +2147,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2127,7 +2175,7 @@ module Google class GoogleCloudVideointelligenceV1p1beta1Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -2167,6 +2215,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -2174,6 +2227,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -2208,9 +2262,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -2230,6 +2284,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -2240,6 +2299,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -2463,6 +2523,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -2474,6 +2539,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -2525,8 +2591,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -2590,6 +2656,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -2598,6 +2669,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -2758,7 +2830,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -2853,13 +2925,13 @@ module Google # @return [Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p1beta1VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made @@ -3061,7 +3133,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -3095,7 +3167,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3123,7 +3195,7 @@ module Google class GoogleCloudVideointelligenceV1p2beta1Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -3163,6 +3235,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -3170,6 +3247,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -3204,9 +3282,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -3226,6 +3304,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -3236,6 +3319,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -3459,6 +3543,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -3470,6 +3559,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -3521,8 +3611,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -3586,6 +3676,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -3594,6 +3689,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -3754,7 +3850,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -3849,13 +3945,13 @@ module Google # @return [Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p2beta1VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made @@ -4037,8 +4133,8 @@ module Google attr_accessor :features # The video data bytes. - # If unset, the input video(s) should be specified via `input_uri`. - # If set, `input_uri` should be unset. + # If unset, the input video(s) should be specified via the `input_uri`. + # If set, `input_uri` must be unset. # Corresponds to the JSON property `inputContent` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -4046,28 +4142,29 @@ module Google # Input video location. Currently, only # [Cloud Storage](https://cloud.google.com/storage/) URIs are - # supported, which must be specified in the following format: + # supported. URIs must be specified in the following format: # `gs://bucket-id/object-id` (other URI formats return # google.rpc.Code.INVALID_ARGUMENT). For more information, see # [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). - # A video URI may include wildcards in `object-id`, and thus identify - # multiple videos. Supported wildcards: '*' to match 0 or more characters; + # To identify multiple videos, a video URI may include wildcards in the + # `object-id`. Supported wildcards: '*' to match 0 or more characters; # '?' to match 1 character. If unset, the input video should be embedded - # in the request as `input_content`. If set, `input_content` should be unset. + # in the request as `input_content`. If set, `input_content` must be unset. # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri # Optional. Cloud region where annotation should take place. Supported cloud - # regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region - # is specified, a region will be determined based on video file location. + # regions are: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no + # region is specified, the region will be determined based on video file + # location. # Corresponds to the JSON property `locationId` # @return [String] attr_accessor :location_id # Optional. Location where the output (in JSON format) should be stored. # Currently, only [Cloud Storage](https://cloud.google.com/storage/) - # URIs are supported, which must be specified in the following format: + # URIs are supported. These must be specified in the following format: # `gs://bucket-id/object-id` (other URI formats return # google.rpc.Code.INVALID_ARGUMENT). For more information, see # [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). @@ -4161,6 +4258,11 @@ module Google # @return [Array] attr_accessor :celebrity_tracks + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4168,6 +4270,7 @@ module Google # Update properties of this object def update!(**args) @celebrity_tracks = args[:celebrity_tracks] if args.key?(:celebrity_tracks) + @version = args[:version] if args.key?(:version) end end @@ -4206,7 +4309,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. # A full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] @@ -4240,7 +4343,7 @@ module Google # @return [Float] attr_accessor :confidence - # The name of this landmark, i.e. left_hand, right_shoulder. + # The name of this landmark, for example, left_hand, right_shoulder. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4268,7 +4371,7 @@ module Google class GoogleCloudVideointelligenceV1p3beta1Entity include Google::Apis::Core::Hashable - # Textual description, e.g. `Fixed-gear bicycle`. + # Textual description, e.g., `Fixed-gear bicycle`. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -4308,6 +4411,11 @@ module Google # @return [Array] attr_accessor :frames + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4315,6 +4423,7 @@ module Google # Update properties of this object def update!(**args) @frames = args[:frames] if args.key?(:frames) + @version = args[:version] if args.key?(:version) end end @@ -4380,6 +4489,11 @@ module Google # @return [Array] attr_accessor :tracks + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4388,6 +4502,7 @@ module Google def update!(**args) @thumbnail = args[:thumbnail] if args.key?(:thumbnail) @tracks = args[:tracks] if args.key?(:tracks) + @version = args[:version] if args.key?(:version) end end @@ -4396,13 +4511,13 @@ module Google include Google::Apis::Core::Hashable # Whether to enable face attributes detection, such as glasses, dark_glasses, - # mouth_open etc. Ignored if 'include_bounding_boxes' is false. + # mouth_open etc. Ignored if 'include_bounding_boxes' is set to false. # Corresponds to the JSON property `includeAttributes` # @return [Boolean] attr_accessor :include_attributes alias_method :include_attributes?, :include_attributes - # Whether bounding boxes be included in the face annotation output. + # Whether bounding boxes are included in the face annotation output. # Corresponds to the JSON property `includeBoundingBoxes` # @return [Boolean] attr_accessor :include_bounding_boxes @@ -4432,9 +4547,9 @@ module Google include Google::Apis::Core::Hashable # Common categories for the detected entity. - # E.g. when the label is `Terrier` the category is likely `dog`. And in some - # cases there might be more than one categories e.g. `Terrier` could also be - # a `pet`. + # For example, when the label is `Terrier`, the category is likely `dog`. And + # in some cases there might be more than one categories e.g., `Terrier` could + # also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -4454,6 +4569,11 @@ module Google # @return [Array] attr_accessor :segments + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4464,6 +4584,7 @@ module Google @entity = args[:entity] if args.key?(:entity) @frames = args[:frames] if args.key?(:frames) @segments = args[:segments] if args.key?(:segments) + @version = args[:version] if args.key?(:version) end end @@ -4475,7 +4596,7 @@ module Google # frame-level detection. If not set, it is set to 0.4 by default. The valid # range for this threshold is [0.1, 0.9]. Any value set outside of this # range will be clipped. - # Note: for best results please follow the default threshold. We will update + # Note: For best results, follow the default threshold. We will update # the default threshold everytime when we release a new model. # Corresponds to the JSON property `frameConfidenceThreshold` # @return [Float] @@ -4495,19 +4616,19 @@ module Google # @return [String] attr_accessor :model - # Whether the video has been shot from a stationary (i.e. non-moving) camera. - # When set to true, might improve detection accuracy for moving objects. - # Should be used with `SHOT_AND_FRAME_MODE` enabled. + # Whether the video has been shot from a stationary (i.e., non-moving) + # camera. When set to true, might improve detection accuracy for moving + # objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. # Corresponds to the JSON property `stationaryCamera` # @return [Boolean] attr_accessor :stationary_camera alias_method :stationary_camera?, :stationary_camera # The confidence threshold we perform filtering on the labels from - # video-level and shot-level detections. If not set, it is set to 0.3 by + # video-level and shot-level detections. If not set, it's set to 0.3 by # default. The valid range for this threshold is [0.1, 0.9]. Any value set # outside of this range will be clipped. - # Note: for best results please follow the default threshold. We will update + # Note: For best results, follow the default threshold. We will update # the default threshold everytime when we release a new model. # Corresponds to the JSON property `videoConfidenceThreshold` # @return [Float] @@ -4747,6 +4868,11 @@ module Google # @return [Fixnum] attr_accessor :track_id + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4758,6 +4884,7 @@ module Google @frames = args[:frames] if args.key?(:frames) @segment = args[:segment] if args.key?(:segment) @track_id = args[:track_id] if args.key?(:track_id) + @version = args[:version] if args.key?(:version) end end @@ -4814,11 +4941,16 @@ module Google class GoogleCloudVideointelligenceV1p3beta1PersonDetectionAnnotation include Google::Apis::Core::Hashable - # The trackes that a person is detected. + # The detected tracks of a person. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -4826,6 +4958,7 @@ module Google # Update properties of this object def update!(**args) @tracks = args[:tracks] if args.key?(:tracks) + @version = args[:version] if args.key?(:version) end end @@ -4834,15 +4967,15 @@ module Google include Google::Apis::Core::Hashable # Whether to enable person attributes detection, such as cloth color (black, - # blue, etc), type (coat, dress, etc), pattern (plain, floral, etc), hair - # color (black, blonde, etc), hair length (long, short, bald), etc. - # Ignored if 'include_bounding_boxes' is false. + # blue, etc), type (coat, dress, etc), pattern (plain, floral, etc), hair, + # etc. + # Ignored if 'include_bounding_boxes' is set to false. # Corresponds to the JSON property `includeAttributes` # @return [Boolean] attr_accessor :include_attributes alias_method :include_attributes?, :include_attributes - # Whether bounding boxes be included in the person detection annotation + # Whether bounding boxes are included in the person detection annotation # output. # Corresponds to the JSON property `includeBoundingBoxes` # @return [Boolean] @@ -4850,7 +4983,7 @@ module Google alias_method :include_bounding_boxes?, :include_bounding_boxes # Whether to enable pose landmarks detection. Ignored if - # 'include_bounding_boxes' is false. + # 'include_bounding_boxes' is set to false. # Corresponds to the JSON property `includePoseLandmarks` # @return [Boolean] attr_accessor :include_pose_landmarks @@ -4959,8 +5092,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is true, you will see all the words - # from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all + # the words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -5041,7 +5174,7 @@ module Google # the top alternative of the recognition result using a speaker_tag provided # in the WordInfo. # Note: When this is true, we send all the words from the beginning of the - # audio for the top alternative in every consecutive responses. + # audio for the top alternative in every consecutive response. # This is done in order to improve our speaker tags as our models learn to # identify the speakers in the conversation over time. # Corresponds to the JSON property `enableSpeakerDiarization` @@ -5119,10 +5252,10 @@ module Google # @return [Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1StreamingVideoAnnotationResults] attr_accessor :annotation_results - # Cloud Storage URI that stores annotation results of one streaming session. - # It is a directory that can hold multiple files in JSON format. - # Example uri format: - # gs://bucket_id/object_id/cloud_project_name-session_id + # Google Cloud Storage(GCS) URI that stores annotation results of one + # streaming session in JSON format. + # It is the annotation_result_storage_directory + # from the request followed by '/cloud_project_number-session_id'. # Corresponds to the JSON property `annotationResultsUri` # @return [String] attr_accessor :annotation_results_uri @@ -5205,6 +5338,11 @@ module Google # @return [String] attr_accessor :text + # Feature version. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + def initialize(**args) update!(**args) end @@ -5213,6 +5351,7 @@ module Google def update!(**args) @segments = args[:segments] if args.key?(:segments) @text = args[:text] if args.key?(:text) + @version = args[:version] if args.key?(:version) end end @@ -5403,7 +5542,7 @@ module Google include Google::Apis::Core::Hashable # Specifies which feature is being tracked if the request contains more than - # one features. + # one feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature @@ -5513,13 +5652,13 @@ module Google # @return [Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1VideoSegment] attr_accessor :segment - # Topical label annotations on video level or user specified segment level. + # Topical label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] attr_accessor :segment_label_annotations - # Presence label annotations on video level or user specified segment level. + # Presence label annotations on video level or user-specified segment level. # There is exactly one element for each unique label. Compared to the # existing topical `segment_label_annotations`, this field presents more # fine-grained, segment-level labels detected in video content and is made diff --git a/generated/google/apis/videointelligence_v1p3beta1/representations.rb b/generated/google/apis/videointelligence_v1p3beta1/representations.rb index 64b3cbaa9..0dbe4dd99 100644 --- a/generated/google/apis/videointelligence_v1p3beta1/representations.rb +++ b/generated/google/apis/videointelligence_v1p3beta1/representations.rb @@ -1007,6 +1007,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -1029,6 +1030,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1LabelSegment, decorator: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1LabelSegment::Representation + property :version, as: 'version' end end @@ -1098,6 +1100,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1VideoSegment, decorator: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -1135,6 +1138,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1TextSegment, decorator: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end @@ -1298,6 +1302,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1beta2ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1beta2ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -1320,6 +1325,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1beta2LabelSegment, decorator: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1beta2LabelSegment::Representation + property :version, as: 'version' end end @@ -1389,6 +1395,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1beta2VideoSegment, decorator: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1beta2VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -1426,6 +1433,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1beta2TextSegment, decorator: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1beta2TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end @@ -1589,6 +1597,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p1beta1ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p1beta1ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -1611,6 +1620,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p1beta1LabelSegment, decorator: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p1beta1LabelSegment::Representation + property :version, as: 'version' end end @@ -1680,6 +1690,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p1beta1VideoSegment, decorator: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p1beta1VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -1717,6 +1728,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p1beta1TextSegment, decorator: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p1beta1TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end @@ -1880,6 +1892,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p2beta1ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p2beta1ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -1902,6 +1915,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p2beta1LabelSegment, decorator: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p2beta1LabelSegment::Representation + property :version, as: 'version' end end @@ -1971,6 +1985,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p2beta1VideoSegment, decorator: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p2beta1VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -2008,6 +2023,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p2beta1TextSegment, decorator: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p2beta1TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end @@ -2165,6 +2181,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :celebrity_tracks, as: 'celebrityTracks', class: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1CelebrityTrack, decorator: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1CelebrityTrack::Representation + property :version, as: 'version' end end @@ -2211,6 +2228,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1ExplicitContentFrame::Representation + property :version, as: 'version' end end @@ -2235,6 +2253,7 @@ module Google property :thumbnail, :base64 => true, as: 'thumbnail' collection :tracks, as: 'tracks', class: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1Track, decorator: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1Track::Representation + property :version, as: 'version' end end @@ -2258,6 +2277,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1LabelSegment, decorator: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1LabelSegment::Representation + property :version, as: 'version' end end @@ -2338,6 +2358,7 @@ module Google property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1VideoSegment, decorator: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1VideoSegment::Representation property :track_id, :numeric_string => true, as: 'trackId' + property :version, as: 'version' end end @@ -2362,6 +2383,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :tracks, as: 'tracks', class: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1Track, decorator: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1Track::Representation + property :version, as: 'version' end end @@ -2463,6 +2485,7 @@ module Google collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1TextSegment, decorator: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1TextSegment::Representation property :text, as: 'text' + property :version, as: 'version' end end diff --git a/generated/google/apis/youtube_partner_v1.rb b/generated/google/apis/youtube_partner_v1.rb index 03b3d1fdf..a25a0ebe3 100644 --- a/generated/google/apis/youtube_partner_v1.rb +++ b/generated/google/apis/youtube_partner_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/youtube/partner/ module YoutubePartnerV1 VERSION = 'V1' - REVISION = '20200326' + REVISION = '20200422' # View and manage your assets and associated content on YouTube AUTH_YOUTUBEPARTNER = 'https://www.googleapis.com/auth/youtubepartner' diff --git a/generated/google/apis/youtube_v3.rb b/generated/google/apis/youtube_v3.rb index eb0e116af..71b94e4eb 100644 --- a/generated/google/apis/youtube_v3.rb +++ b/generated/google/apis/youtube_v3.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/youtube/v3 module YoutubeV3 VERSION = 'V3' - REVISION = '20200402' + REVISION = '20200423' # Manage your YouTube account AUTH_YOUTUBE = 'https://www.googleapis.com/auth/youtube'